VgINavigationInstruction Class Reference

Inheritance diagram for VgINavigationInstruction:

Public Member Functions
double	getLength ()
VgManeuverType	getManeuverType ()
String	getLayer ()
float	getHeight ()
String	getModality ()
float	getTime ()
float	getTotalTime ()
float	getETA ()
float	getDuration ()
long	getIndex ()
VgPosition	getPosition ()
VgNearPlaceVector	getNearPlaces ()
boolean	isEndOrTransitionPoint ()
VgPositionVector	getInstructionPositions ()
VgStringSet	getAttributes ()
long	getDestinationIndex ()
Public Member Functions inherited from VgReferenced
synchronized void	release ()
	VgReferenced ()
	VgReferenced (VgReferenced pThis)
void	ref ()
int	unref ()
int	getNbReferences ()

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

VgStringSet VgINavigationInstruction.getAttributes

(

)

Returns all the attributes of the traversed edges in a std::set. Includes result of "edge" the current and the next layer if applicable. The current VisioMapEditor floor transition attributes are "stairway", "escalator", and "lift".

Version

2.0.7729

2.1.9 Includes result of "edge" the current and the next layer if applicable.

long VgINavigationInstruction.getDestinationIndex

(

)

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

Version

2.1.4

See also

VgRoutingModule::VgIRouteRequestParameters

Returns

destination index of the instruction with regards to VgIRouteRequestParameters mDestinations

float VgINavigationInstruction.getDuration

(

)

Gets the duration.

Version

2.0.7729

Returns

The duration of the instruction in seconds

float VgINavigationInstruction.getETA

(

)

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

Version

2.0.7729

Returns

The ETA of the instruction. This is equal to getTotalTime() - getTime().

float VgINavigationInstruction.getHeight

(

)

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.

Version

2.1.3

Returns

The height of the instruction in meters.

long VgINavigationInstruction.getIndex

(

)

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

Returns

index of the instruction.

VgPositionVector VgINavigationInstruction.getInstructionPositions

(

)

Returns all the intermediate positions of the instruction.

String VgINavigationInstruction.getLayer

(

)

Gets the layer name of the instruction.

Version

2.0

Returns

The layer name of the instruction.

double VgINavigationInstruction.getLength

(

)

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.

VgManeuverType VgINavigationInstruction.getManeuverType

(

)

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

Returns

the maneuver type of the maneuver.

References VgManeuverType.swigToEnum().

String VgINavigationInstruction.getModality

(

)

Gets the name of the used modality.

Version

2.0.7729

Returns

The modality name of the instruction.

VgNearPlaceVector VgINavigationInstruction.getNearPlaces

(

)

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.

VgPosition VgINavigationInstruction.getPosition

(

)

Gets the position of the start of the instruction

Returns

Position of start of instruction.

float VgINavigationInstruction.getTime

(

)

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

Version

2.0.7729

Returns

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

float VgINavigationInstruction.getTotalTime

(

)

Gets the total duration of the route.

Version

2.0.7729

Returns

The total time of this instruction's route in seconds

boolean VgINavigationInstruction.isEndOrTransitionPoint

(

)

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.java