VgRoutingModule::VgIRouteRequestParameters Struct Reference

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

Collaboration diagram for VgRoutingModule::VgIRouteRequestParameters:

List of all members.

Public Member Functions
	VgIRouteRequestParameters ()
	~VgIRouteRequestParameters ()
Public Attributes
VgIRouteRequestType	mRequestType
	Tells which apsect of route to optimize (time or distance) default is time.
VgEngine::VgRefPtr < VgIRoutingNode >	mOrigin
	Start point of route.
std::vector < VgEngine::VgRefPtr < VgIRoutingNode > >	mDestinations
	Contains a list of waypoints that must be present on the route.
std::set< std::string >	mExcludedAttributes
	Attributes to be excluded from the route (e.g.
std::set< std::string >	mExcludedModalities
	Modalities to be excluded from the route (e.g.
VgEngine::VgRefPtr < VgIRouteCallback >	mCallback
	Callback to communicate with route requester.

---

Detailed Description

An object containing parameters to perform a route request.

---

Constructor & Destructor Documentation

VgRoutingModule::VgIRouteRequestParameters::VgIRouteRequestParameters

(

)

[inline]

VgRoutingModule::VgIRouteRequestParameters::~VgIRouteRequestParameters

(

)

[inline]

---

Member Data Documentation

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

Callback to communicate with route requester.

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)

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)

Version:

2.0.7729

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

Start point of route.

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:

• VgIRoutingSolver.h