The VgINavigationListener allow users to be notified of Navigation related events that occur within a VgINavigation Object where the listener has been registered. More...

Inheritance diagram for VgNavigationModule::VgINavigationInstruction:

Public Member Functions
virtual double	getLength () const =0
	Gets the distance between start of this instruction to the start of the next instruction. More...

virtual VgManeuverType	getManeuverType () const =0
	Gets the maneuver type to perform at end of the instruction. More...

virtual const std::string &	getLayer () const =0
	Gets the layer name of the instruction. More...

virtual float	getHeight () const =0
	Gets the height of the instruction in meters. More...

virtual const std::string &	getModality () const =0
	Gets the name of the used modality. More...

virtual float	getTime () const =0
	Gets the time (not duration) relative to full route start. More...

virtual float	getTotalTime () const =0
	Gets the total duration of the route. More...

virtual float	getETA () const =0
	Gets the estimated remaining time in seconds (at start of this instruction). More...

virtual float	getDuration () const =0
	Gets the duration. More...

virtual unsigned int	getIndex () const =0
	Gets the index of the instruction, the index is 0-based, thus always less than VgINavigation->getNumInstructions(). More...

virtual const VgEngine::VgPosition &	getPosition () const =0
	Gets the position of the start of the instruction. More...

virtual const std::vector < VgNearPlace >	getNearPlaces () const =0
	Get the PlaceIDs of places near the end of the instruction. More...

virtual bool	isEndOrTransitionPoint () const =0

virtual const std::vector < VgEngine::VgPosition > &	getInstructionPositions () const =0
	Returns all the intermediate positions of the instruction. More...

virtual const std::set < std::string > &	getAttributes () const =0
	Returns all the attributes of the traversed edges in a std::set. More...

virtual unsigned int	getDestinationIndex () const =0
	Gets the index of the current destination instruction, the index is 0-based, thus always less than VgINavigation->getNumInstructions(). More...

Public Member Functions inherited from VgEngine::VgReferenced
	VgReferenced ()
	Constructor. More...

	VgReferenced (const VgReferenced &pThis)
	Copy constructor. More...

virtual	~VgReferenced ()
	Destructor. More...

VgReferenced &	operator= (const VgReferenced &pThis)
	Assignment operator. More...

void	ref () const
	This method is used to add a reference to this object. More...

int	unref () const
	This method is used to remove a reference to this object. More...

int	getNbReferences () const
	Retrieves the number of references to this object. More...

Additional Inherited Members
Protected Attributes inherited from VgEngine::VgReferenced
int	mNbReferences
	The number of references to this object. More...

Detailed Description

The VgINavigationListener allow users to be notified of Navigation related events that occur within a VgINavigation Object where the listener has been registered.

Member Function Documentation

virtual const std::set< std::string >& VgNavigationModule::VgINavigationInstruction::getAttributes ( ) const

pure virtual

Returns all the attributes of the traversed edges in a std::set.

Version: 2.0.7729

virtual unsigned int VgNavigationModule::VgINavigationInstruction::getDestinationIndex ( ) const

pure virtual

Gets the index of the current destination instruction, the index is 0-based, thus always less than VgINavigation->getNumInstructions().

Returns: destination index of the instruction with regards to VgIRouteRequestParameters mDestinations

Version: 2.1.4

See Also: VgRoutingModule::VgIRouteRequestParameters

virtual float VgNavigationModule::VgINavigationInstruction::getDuration ( ) const

pure virtual

Gets the duration.

Returns: The duration of the instruction in seconds

Version: 2.0.7729

virtual float VgNavigationModule::VgINavigationInstruction::getETA ( ) const

pure virtual

Gets the estimated remaining time in seconds (at start of this instruction).

Returns: The ETA of the instruction.

Version: 2.0.7729

virtual float VgNavigationModule::VgINavigationInstruction::getHeight ( ) const

pure virtual

Gets the height of the instruction in meters.

This is the same as getting the layer name and using VgMapModule::getHeightRangeForLayer() and taking the average.

Returns: The height of the instruction in meters.

Version: 2.1.3

virtual unsigned int VgNavigationModule::VgINavigationInstruction::getIndex ( ) const

pure virtual

Gets the index of the instruction, the index is 0-based, thus always less than VgINavigation->getNumInstructions().

Returns: index of the instruction.

virtual const std::vector<VgEngine::VgPosition>& VgNavigationModule::VgINavigationInstruction::getInstructionPositions ( ) const

pure virtual

Returns all the intermediate positions of the instruction.

virtual const std::string& VgNavigationModule::VgINavigationInstruction::getLayer ( ) const

pure virtual

Gets the layer name of the instruction.

Returns: The layer name of the instruction.

Version: 2.0

virtual double VgNavigationModule::VgINavigationInstruction::getLength ( ) const

pure virtual

Gets the distance between start of this instruction to the start of the next instruction.

Returns: distance in meters. The value will be 0 if the instruction is at the end of the route.

virtual VgManeuverType VgNavigationModule::VgINavigationInstruction::getManeuverType ( ) const

pure virtual

Gets the maneuver type to perform at end of the instruction.

Returns: the maneuver type of the maneuver.

virtual const std::string& VgNavigationModule::VgINavigationInstruction::getModality ( ) const

pure virtual

Gets the name of the used modality.

Returns: The modality name of the instruction.

Version: 2.0.7729

virtual const std::vector<VgNearPlace> VgNavigationModule::VgINavigationInstruction::getNearPlaces ( ) const

pure virtual

Get the PlaceIDs of places near the end of the instruction.

This information is useful to complement the navigation instructions. They are ordered by places that are closests to the inside of turns for natural guidance. The number of places available will be a function of the value of VgModalityParameterType::eNearPlacesThreshold at the time the navigation instructions where computed. It may be empty if there are no places that are closer than VgModalityParameterType::eNearPlacesThreshold.

Version: 2.1.2 it will return only places that are on the same layer as the instruction.

virtual const VgEngine::VgPosition& VgNavigationModule::VgINavigationInstruction::getPosition ( ) const

pure virtual

Gets the position of the start of the instruction.

Returns: Position of start of instruction.

virtual float VgNavigationModule::VgINavigationInstruction::getTime ( ) const

pure virtual

Gets the time (not duration) relative to full route start.

Returns: The time of the instruction from start of navigation in seconds, the first instruction will have time 0.

Version: 2.0.7729

virtual float VgNavigationModule::VgINavigationInstruction::getTotalTime ( ) const

pure virtual

Gets the total duration of the route.

Returns: The total time of this instruction's route in seconds

Version: 2.0.7729

virtual bool VgNavigationModule::VgINavigationInstruction::isEndOrTransitionPoint ( ) const

pure virtual

Returns: true if the instruction is the last one or if the instruction is the first one at a given floor or overall. Used to customize the written navigation instructions.

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

VgINavigationInstruction.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation