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.

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 VgNavigationModule::eVgManeuverTypeGoDown and VgNavigationModule::eVgManeuverTypeGoUp will not be generated, These maneuvers will be merged with the previous instruction.

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 mModalityParameters["shuttle"][VgNavigationModule::eStraightAngleThreshold] = 180.0f;

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: