VgIRoutingModule Class Reference

Inheritance diagram for VgIRoutingModule:

Public Member Functions
VgIRoutingSolver	getRoutingSolver ()
VgIRouteConverterFactory	getRouteConverterFactory ()
int	setEdgeTimeByAttributeAndModality (String pEdgeAttribute, String pModality, float pTime)
void	getAllModalityNames (VgStringVector pNames)
void	getAllAttributeNames (VgStringVector pNames)
Public Member Functions inherited from VgIModule
String	getName ()

Detailed Description

VgIRoutingModule provides access to routing related objects

Member Function Documentation

void VgIRoutingModule.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.

Version

2.0.7729

void VgIRoutingModule.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.

Version

2.0.7729

VgIRouteConverterFactory VgIRoutingModule.getRouteConverterFactory

(

)

Retrieves the route converter factor.

VgIRoutingSolver VgIRoutingModule.getRoutingSolver

(

)

Retrieves the routing solver.

Returns

VgIRoutingSolver if valid, otherwise NULL.

int VgIRoutingModule.setEdgeTimeByAttributeAndModality	(	String	pEdgeAttribute,
		String	pModality,
		float	pTime
	)

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

Remarks

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

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 (should be positive)

Version

2.0.7729

Returns

The number of edges that were affected.

---

The documentation for this class was generated from the following file:

• VgIRoutingModule.java