VgNavigationModule::VgINavigation Class Reference

VgINavigation represents a Navigation object. More...

Inheritance diagram for VgNavigationModule::VgINavigation:

Collaboration diagram for VgNavigationModule::VgINavigation:

List of all members.

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

---

Detailed Description

VgINavigation represents a Navigation object.

---

Constructor & Destructor Documentation

VgNavigationModule::VgINavigation::VgINavigation

(

)

[inline, protected]

Constructor.

virtual VgNavigationModule::VgINavigation::~VgINavigation

(

)

[inline, virtual]

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