An object containing parameters to perform a route request. More...

Public Member Functions
	VgIRouteRequestParameters ()

	~VgIRouteRequestParameters ()

Public Attributes
VgIRouteRequestType	mRequestType
	Tells which apsect of route to optimize (time or distance) default is time. More...

VgEngine::VgRefPtr < VgIRoutingNode >	mOrigin
	Start point of route. More...

std::vector < VgEngine::VgRefPtr < VgIRoutingNode > >	mDestinations
	Contains a list of waypoints that must be present on the route. More...

std::set< std::string >	mExcludedAttributes
	Attributes to be excluded from the route (e.g. More...

std::set< std::string >	mExcludedModalities
	Modalities to be excluded from the route (e.g. More...

VgEngine::VgRefPtr < VgIRouteCallback >	mCallback
	Callback that will be notified when the route has been commputed. More...

Detailed Description

An object containing parameters to perform a route request.

Constructor & Destructor Documentation

VgRoutingModule::VgIRouteRequestParameters::VgIRouteRequestParameters ( )

inline

VgRoutingModule::VgIRouteRequestParameters::~VgIRouteRequestParameters ( )

inline

VgEngine::VgRefPtr< VgIRouteCallback > VgRoutingModule::VgIRouteRequestParameters::mCallback

Callback that will be notified when the route has been commputed.

This is required in order to receive the result of the computed route.

std::vector< VgEngine::VgRefPtr< VgIRoutingNode > > VgRoutingModule::VgIRouteRequestParameters::mDestinations

Contains a list of waypoints that must be present on the route.

Note: Currently, only the position at the front of the vector is used as a destination for the computed route.

std::set< std::string > VgRoutingModule::VgIRouteRequestParameters::mExcludedAttributes

Attributes to be excluded from the route (e.g.

"stairs" for disabled persons)

Use VgIRoutingModule::getAllAttributeNames to retreive a list of attributes available within the current routing network.

std::set< std::string > VgRoutingModule::VgIRouteRequestParameters::mExcludedModalities

Modalities to be excluded from the route (e.g.

'do not use car' or 'do not use shuttles)

Use VgIRoutingModule::getAllModalityNames to retreive a list of modalities available within the current routing network.

VgEngine::VgRefPtr< VgIRoutingNode > VgRoutingModule::VgIRouteRequestParameters::mOrigin

Start point of route.

Note: Use VgIRoutingSolver::getRoutingNode to get the corresponding routing node to either a position or a place id.

VgIRouteRequestType VgRoutingModule::VgIRouteRequestParameters::mRequestType

Tells which apsect of route to optimize (time or distance) default is time.

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