VgRoutingModule::VgIRoutingModule Class Reference

VgIRoutingModule provides access to routing related objects. More...

Inheritance diagram for VgRoutingModule::VgIRoutingModule:

Public Member Functions
virtual	~VgIRoutingModule ()
	Destructor. More...
virtual VgIRoutingSolver *	getRoutingSolver ()=0
	Retrieves the routing solver. More...
virtual VgIRouteConverterFactory *	getRouteConverterFactory ()=0
	Retrieves the route converter factor. More...
virtual int	setEdgeTimeByAttributeAndModality (const std::string &pEdgeAttribute, const std::string &pModality, float pTime)=0
	This method is used to set the traversal time for a given modality on. More...
virtual void	getAllModalityNames (std::vector< std::string > &pNames) const =0
	This method is used to get the names of all the modalities present in the database. More...
virtual void	getAllAttributeNames (std::vector< std::string > &pNames) const =0
	This method is used to get the names of all the attributes present in the database. More...
Public Member Functions inherited from VgApplication::VgIModule
virtual	~VgIModule ()
	Destructor. More...
virtual const std::string &	getName () const =0
	Retrieves the module name. More...

Protected Member Functions
	VgIRoutingModule ()
	Constructor. More...
Protected Member Functions inherited from VgApplication::VgIModule
	VgIModule ()
	Constructor. More...

Detailed Description

VgIRoutingModule provides access to routing related objects.

Constructor & Destructor Documentation

VgRoutingModule::VgIRoutingModule::VgIRoutingModule ( )

inlineprotected

Constructor.

virtual VgRoutingModule::VgIRoutingModule::~VgIRoutingModule ( )

inlinevirtual

Destructor.

Member Function Documentation

virtual void VgRoutingModule::VgIRoutingModule::getAllAttributeNames ( std::vector< std::string > &  pNames ) const

pure virtual

This method is used to get the names of all the attributes present in the database.

It can return an empty vector if no modalities are specified within the database.

Parameters

pNames

The list of strings that will be fed with the attribute names.

Version

2.0.7729

virtual void VgRoutingModule::VgIRoutingModule::getAllModalityNames ( std::vector< std::string > &  pNames ) const

pure virtual

This method is used to get the names of all the modalities present in the database.

It can return an empty vector if no modalities are specified within the database.

Parameters

pNames

The list of strings that will be fed with the modality names.

Version

2.0.7729

virtual VgIRouteConverterFactory* VgRoutingModule::VgIRoutingModule::getRouteConverterFactory ( )

pure virtual

Retrieves the route converter factor.

virtual VgIRoutingSolver* VgRoutingModule::VgIRoutingModule::getRoutingSolver ( )

pure virtual

Retrieves the routing solver.

Returns

VgIRoutingSolver if valid, otherwise NULL.

virtual int VgRoutingModule::VgIRoutingModule::setEdgeTimeByAttributeAndModality ( const std::string &  pEdgeAttribute, const std::string &  pModality, float  pTime  )

pure virtual

This method is used to set the traversal time for a given modality on.

edges with a given attribute. It returns the number of affected edges.

Parameters

pEdgeAttribute	The searched attributes. All edges with that 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.

Remarks

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

Version

2.0.7729

---

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

• VgIRoutingModule.h