VgNavigationModule::VgINavigationRequestParameters Struct Reference

VgINavigationRequestParameters is used when computing a navigation and provides a mechanism to customise the computed navigation object. More...

Public Member Functions
	VgINavigationRequestParameters (VgEngine::UInt pAttributes, VgEngine::VgRefPtr< VgINavigationCallback >const &pCallback, VgEngine::VgRefPtr< VgRoutingModule::VgIRoute > const &pRoute)
	Constructor. More...
	~VgINavigationRequestParameters ()
	Destructor. More...

Public Attributes
VgEngine::VgRefPtr < VgINavigationCallback >	mCallback
	Callback to communicate with navigation requester. More...
VgEngine::VgRefPtr < VgRoutingModule::VgIRoute >	mRoute
	Route for which the navigation object is calculated. More...
bool	mMergeFloorChangeInstructions
	Merge floor change instructions. More...
std::map< std::string, std::map < VgModalityParameterType, double > >	mModalityParameters
	The parameter map. More...

Detailed Description

VgINavigationRequestParameters is used when computing a navigation and provides a mechanism to customise the computed navigation object.

Constructor & Destructor Documentation

VgNavigationModule::VgINavigationRequestParameters::VgINavigationRequestParameters ( VgEngine::UInt  pAttributes, VgEngine::VgRefPtr< VgINavigationCallback >const &  pCallback, VgEngine::VgRefPtr< VgRoutingModule::VgIRoute > const &  pRoute  )

inline

Constructor.

Parameters

pAttributes	For internall use only, use 0.
pCallback	The callback to be used to communicate with the navigation requester
pRoute	The route for which the navigation will be constructed.

VgNavigationModule::VgINavigationRequestParameters::~VgINavigationRequestParameters ( )

inline

Destructor.

Member Data Documentation

VgEngine::VgRefPtr< VgINavigationCallback > VgNavigationModule::VgINavigationRequestParameters::mCallback

Callback to communicate with navigation requester.

bool VgNavigationModule::VgINavigationRequestParameters::mMergeFloorChangeInstructions

Merge floor change instructions.

Default value false. If true, the following maneuvers will not be generated: VgNavigationModule::eVgManeuverTypeGoDown VgNavigationModule::eVgManeuverTypeGoUp, VgNavigationModule::eVgManeuverTypeChangeModality, VgNavigationModule::eVgManeuverTypeChangeLayer

These maneuvers will be merged with the previous instruction.

Remarks

this parameter could be renamed in future versions

Version

2.1.2

std::map< std::string, std::map< VgModalityParameterType, double > > VgNavigationModule::VgINavigationRequestParameters::mModalityParameters

The parameter map.

Any non-existent parameter wil be considered having the default value. For example:

...
VgNavigationModule::VgINavigationRequestParameters lNavigationParams(0, mNavigationCallback, pRoute);
// Customize attributes
lNavigationParams.mModalityParameters["shuttle"][VgNavigationModule::eStraightAngleThreshold] = 180.0f;
lNavigationParams.mModalityParameters["shuttle"][VgNavigationModule::eDistanceFromCouloirThreshold] = 2.0f;
lNavigationParams.mModalityParameters["shuttle"][VgNavigationModule::eNearPlacesThreshold] = 10.0f;
lNavigationParams.mModalityParameters["shuttle"][VgNavigationModule::eMinimumInstructionLength] = 100.0f;
...

Version

2.0.7729

VgEngine::VgRefPtr< VgRoutingModule::VgIRoute > VgNavigationModule::VgINavigationRequestParameters::mRoute

Route for which the navigation object is calculated.

---

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

• VgINavigationModule.h