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

Public Member Functions
	VgIRouteRequestParameters ()

	~VgIRouteRequestParameters ()

Public Attributes
VgIRouteDestinationsOrder	mDestinationsOrder
	Tells how multiple destinations should be traversed. More...

VgIRouteRequestType	mRequestType
	Tells which aspect 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.

The traversal order is determined by mDestinationsOrder.

Note: If using multiple destinations (mDestinations.size() > 0), only the last node of the mDestinations can be based on a position (as opposed to an poi ID), otherwise the route computation will failed.

VgIRouteDestinationsOrder VgRoutingModule::VgIRouteRequestParameters::mDestinationsOrder

Tells how multiple destinations should be traversed.

Default is in order. Note: using eOptimal or eOptimalFinishOnLast can take a very long time for a large number of mDestinations.

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

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

"stairs" for disabled persons)

Use VgIRoutingModule::getAllAttributeNames to retrieve 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 retrieve 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 aspect of route to optimize (time or distance) default is time.

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