VgRoutingModule::VgIRouteRequestParameters Struct Reference

Public Types
typedef std::map< std::string, std::string >	StringStringMap
typedef std::set< std::string >	StringSet

Public Member Functions
	VgIRouteRequestParameters ()
	~VgIRouteRequestParameters ()

Public Attributes
VgIRouteDestinationsOrder	mDestinationsOrder
VgIRouteRequestType	mRequestType
VgEngine::VgRefPtr< VgIRoutingNode >	mOrigin
std::vector< VgEngine::VgRefPtr< VgIRoutingNode > >	mDestinations
std::set< std::string >	mExcludedAttributes
std::set< std::string >	mExcludedModalities
std::map< std::string, std::string >	mRemapResultingModality
VgEngine::VgRefPtr< VgIRouteCallback >	mCallback

Detailed Description

An object containing parameters to perform a route request.

Member Typedef Documentation

typedef std::set< std::string > VgRoutingModule::VgIRouteRequestParameters::StringSet

typedef std::map< std::string, std::string > VgRoutingModule::VgIRouteRequestParameters::StringStringMap

Constructor & Destructor Documentation

VgRoutingModule::VgIRouteRequestParameters::VgIRouteRequestParameters ( )

inline

VgRoutingModule::VgIRouteRequestParameters::~VgIRouteRequestParameters ( )

inline

References mCallback, and mDestinations.

Member Data Documentation

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.

Referenced by ~VgIRouteRequestParameters().

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.

Referenced by ~VgIRouteRequestParameters().

VgIRouteDestinationsOrder VgRoutingModule::VgIRouteRequestParameters::mDestinationsOrder

Tells how multiple destinations should be traversed. Default is eOptimalFinishOnLast. Note: using eOptimal or eOptimalFinishOnLast can take a very long time for a large number of mDestinations.

Version

2.1.4

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.

Version

2.0.7729

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.

Version

2.0.7729

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.

std::map< std::string, std::string > VgRoutingModule::VgIRouteRequestParameters::mRemapResultingModality

Remaps a source modality so that it is not visible on the VgIRoute or navigation computation

This will affect the resuling route, by replacing the source modality (key) by the target modality (value) Neither the route result nor the navigation computation will not have any reference of the source modality, even if it was used for the route (it will be marked as being the target modality). This does not change the resulting length or duration. Use VgIRoutingModule::getAllModalityNames to retrieve a list of modalities available within the current routing network.

lRoutingRequestParameters.mRemapResultingModality.clear();
lRoutingRequestParameters.mRemapResultingModality["Travelator"] = "pedestrian";
lRoutingRequestParameters.mRemapResultingModality["vipline"] = "pedestrian";

Version

2.1.7

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:

• VgIRoutingSolver.h