com.visioglobe.libVisioDevKit

Class VgIRoutingModule

java.lang.Object

com.visioglobe.libVisioDevKit.VgIModule

com.visioglobe.libVisioDevKit.VgIRoutingModule

public class VgIRoutingModule
extends VgIModule

VgIRoutingModule provides access to routing related objects

Method Summary

Methods

Modifier and Type	Method and Description
void	delete()
void	getAllAttributeNames(VgStringVector pNames) This method is used to get the names of all the attributes present in the database.
void	getAllModalityNames(VgStringVector pNames) This method is used to get the names of all the modalities present in the database.
VgIRouteConverterFactory	getRouteConverterFactory() Retrieves the route converter factor.
VgIRoutingSolver	getRoutingSolver() Retrieves the routing solver.
int	setEdgeTimeByAttributeAndModality(java.lang.String pEdgeAttribute, java.lang.String pModality, float pTime) Sets the traversal time for a given modality on edges with a given attribute.

Methods inherited from class com.visioglobe.libVisioDevKit.VgIModule

getName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

delete

public void delete()

Overrides:

delete in class VgIModule

getRoutingSolver

public VgIRoutingSolver getRoutingSolver()

Retrieves the routing solver.

Returns:

VgIRoutingSolver if valid, otherwise NULL.

getRouteConverterFactory

public VgIRouteConverterFactory getRouteConverterFactory()

Retrieves the route converter factor.

setEdgeTimeByAttributeAndModality

public int setEdgeTimeByAttributeAndModality(java.lang.String pEdgeAttribute,
                                    java.lang.String pModality,
                                    float pTime)

Sets the traversal time for a given modality on edges with a given attribute.

Parameters:

pEdgeAttribute - The searched attributes. All edges containing this attribute will be affected.

pModality - The affected modality (time can only be set for modalities, no time concept in edges alone).

pTime - The time to associate.

Returns:

The number of edges that were affected.

Remark:

The change to the edge's time is not persistent across loadConfigurations. It must be done every time the configuration is loaded.

getAllModalityNames

public void getAllModalityNames(VgStringVector pNames)

This method is used to get the names of all the modalities present in the database. Within the database, each routing edge may have zero or more modalities associated with it. An example of a modality might be "pedestrian" or "shuttle" and represents a method of movement.

Parameters:

pNames - The list of strings that will be fed with the modality names. This may return an empty vector if no modalities are specified within the database.

getAllAttributeNames

public void getAllAttributeNames(VgStringVector pNames)

This method is used to get the names of all the attributes present in the database. Within the database, each routing node may have zero or more attributes associated with it. An example of a attributes might be "stairs" or "lift" and represents a physical medium. Currently, attribute are used to indicate floor transition types.

Parameters:

pNames - The list of strings that will be fed with the attribute names. This may return an empty vector if no attributes are specified within the database.