VgNavigationModule::VgINavigation Class Reference

VgINavigation represents a Navigation object. More...

Inheritance diagram for VgNavigationModule::VgINavigation:

Public Member Functions
virtual	~VgINavigation ()
	Destructor. More...
virtual void	addListener (VgEngine::VgRefPtr< VgINavigationListener >const &pListener)=0
	Adds a listener to the navgiation object. More...
virtual void	removeListener (VgEngine::VgRefPtr< VgINavigationListener >const &pListener)=0
	Removes a listener from the navigation object. More...
virtual VgEngine::VgConstRefPtr < VgNavigationModule::VgINavigationInstruction >	getInstruction (unsigned int pIndex) const =0
	Gets a navigation instruction. More...
virtual const unsigned int	getNumInstructions () const =0
	Gets the number of navigation instructions. More...
virtual void	updateCurrentPosition (const VgEngine::VgPosition &pPosition, double pTime)=0
	Injects new position. More...
virtual const VgEngine::VgPosition &	getCurrentPosition () const =0
	Gets the last position that was notified. More...
virtual unsigned int	getCurrentInstructionIndex () const =0
	Gets the index of the active instruction. More...
virtual const VgEngine::VgPosition &	getClosestPositionOnRoute () const =0
	Calculates the closest position on the route, given the current position (VgINavigation::getCurrentPosition()). More...
virtual double	getDistanceFromRoute () const =0
	Gets the distance between current position (VgINavigation::getCurrentPosition()) and closest position on route. More...
virtual void	setInstructionGeofenceDistance (double pDistanceInMeters)=0
	Sets the distance in meters of the threshold when to switch instructions. More...
virtual double	getInstructionGeofenceDistance () const =0
	Gets the distance in meters of the threshold when to switch instructions. More...
virtual const VgINavigationRequestParameters &	getRequestParameters () const =0
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...
void	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...

Protected Member Functions
	VgINavigation ()
	Constructor. More...

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

Detailed Description

VgINavigation represents a Navigation object.

Constructor & Destructor Documentation

VgNavigationModule::VgINavigation::VgINavigation ( )

inlineprotected

Constructor.

virtual VgNavigationModule::VgINavigation::~VgINavigation ( )

inlinevirtual

Destructor.

Member Function Documentation

virtual void VgNavigationModule::VgINavigation::addListener ( VgEngine::VgRefPtr< VgINavigationListener >const &  pListener )

pure virtual

Adds a listener to the navgiation object.

Parameters

pListener

The navigation listener to be added.

virtual const VgEngine::VgPosition& VgNavigationModule::VgINavigation::getClosestPositionOnRoute ( ) const

pure virtual

Calculates the closest position on the route, given the current position (VgINavigation::getCurrentPosition()).

Returns

Position on route.

virtual unsigned int VgNavigationModule::VgINavigation::getCurrentInstructionIndex ( ) const

pure virtual

Gets the index of the active instruction.

The value will be the same as the last value given by VgINavigationListener::notifyNewInstruction().

Returns

The index of the active instruction

virtual const VgEngine::VgPosition& VgNavigationModule::VgINavigation::getCurrentPosition ( ) const

pure virtual

Gets the last position that was notified.

This value will be the same as the last value given by VgINavigationListener::notifyPositionUpdated().

Returns

Last injected position.

virtual double VgNavigationModule::VgINavigation::getDistanceFromRoute ( ) const

pure virtual

Gets the distance between current position (VgINavigation::getCurrentPosition()) and closest position on route.

Returns

Distance in meters from route.

virtual VgEngine::VgConstRefPtr< VgNavigationModule::VgINavigationInstruction > VgNavigationModule::VgINavigation::getInstruction ( unsigned int  pIndex ) const

pure virtual

Gets a navigation instruction.

Parameters

pIndex

index of instruction

Returns

Instruction with index pIndex, or NULL if pIndex >+ VgINavigation::getNumInstructions ()

virtual double VgNavigationModule::VgINavigation::getInstructionGeofenceDistance ( ) const

pure virtual

Gets the distance in meters of the threshold when to switch instructions.

Returns

the radius distance in meters.

virtual const unsigned int VgNavigationModule::VgINavigation::getNumInstructions ( ) const

pure virtual

Gets the number of navigation instructions.

Returns

Number of instructions

virtual const VgINavigationRequestParameters& VgNavigationModule::VgINavigation::getRequestParameters ( ) const

pure virtual

Returns

the NavigationRequest parameters with which the request was made.

virtual void VgNavigationModule::VgINavigation::removeListener ( VgEngine::VgRefPtr< VgINavigationListener >const &  pListener )

pure virtual

Removes a listener from the navigation object.

Parameters

pListener

The navigation listener to be removed.

virtual void VgNavigationModule::VgINavigation::setInstructionGeofenceDistance ( double  pDistanceInMeters )

pure virtual

Sets the distance in meters of the threshold when to switch instructions.

this number is a function of the accuracy of the position information. If too large, instructions will switch rapidly, if too small, instructions will not change.

Note

This function should be called at the moment the application is notified of the result of a navigation computation.

Parameters

pDistanceInMeters

Radius distance in meters.

virtual void VgNavigationModule::VgINavigation::updateCurrentPosition ( const VgEngine::VgPosition &  pPosition, double  pTime  )

pure virtual

Injects new position.

This will trigger a VgINavigationListener::notifyPositionUpdated() event. This method can be used to connect a location provider service to the navigation object.

Parameters

pPosition	The new current position.
pTime	Time of the position capture. If unknown, use 0.

Remarks

this called should be done on the main thread as the SDK is not thread-safe and the VgINavigationListener::notifyPositionUpdated() might interact with the engine as well. see FAQ.

---

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

• VgINavigation.h