VgNavigationModule::VgINavigationRequestParameters Struct Reference

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

Public Attributes
VgEngine::VgRefPtr< VgINavigationCallback >	mCallback
VgEngine::VgRefPtr< VgRoutingModule::VgIRoute >	mRoute
bool	mMergeFloorChangeInstructions
std::map< std::string, std::map< VgModalityParameterType, double > >	mModalityParameters
VgNavigationAlgorithm	mAlgorithm
bool	mFirstNodeAsIntersection

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.

Version

2.1.7 updated default value of mMergeFloorChangeInstructions to true.

VgNavigationModule::VgINavigationRequestParameters::VgINavigationRequestParameters ( VgEngine::VgRefPtr< VgRoutingModule::VgIRoute > const &  pRoute )

inline

Constructor

Parameters

pRoute

The route for which the navigation will be constructed, should be valid.

Version

2.1.8 updated default value of mMergeFloorChangeInstructions to true.

VgNavigationModule::VgINavigationRequestParameters::~VgINavigationRequestParameters ( )

inline

Destructor

References mCallback, mModalityParameters, and mRoute.

Member Data Documentation

VgNavigationAlgorithm VgNavigationModule::VgINavigationRequestParameters::mAlgorithm

Determines which Navigation algorithm it will be used. Default value is eNavigationAlgorithmAuto

Version

2.1.7

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

Callback to communicate with navigation requester

Referenced by ~VgINavigationRequestParameters().

bool VgNavigationModule::VgINavigationRequestParameters::mFirstNodeAsIntersection

If true, it will consider the first node (after access) in the first segment of a route to be an intersection. This allows to generate an instruction turn right/left when exiting a POI. Default value false.

Version

2.1.7

2.1.9 Includes the first node after a waypoint.

bool VgNavigationModule::VgINavigationRequestParameters::mMergeFloorChangeInstructions

Merge floor change instructions. Default value true. If true, the following maneuvers will not be generated: VgNavigationModule::eVgManeuverTypeGoDown, VgNavigationModule::eVgManeuverTypeGoUp, VgNavigationModule::eVgManeuverTypeChangeModality, VgNavigationModule::eVgManeuverTypeChangeLayer, VgNavigationModule::eVgManeuverTypeWaypoint

These maneuvers will be merged with the previous instruction.

Remarks

this parameter could be renamed in future versions

Version

2.1.2

2.1.7 updated default value to true.

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

2.1.7 updated default VgNavigationModule::eStraightAngleThreshold to 30 degrees.

Referenced by ~VgINavigationRequestParameters().

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

Route for which the navigation object is calculated

Referenced by ~VgINavigationRequestParameters().

---

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

• VgINavigationModule.h