com.visioglobe.libVisioDevKit
Class VgINavigationInstruction

java.lang.Object
  com.visioglobe.libVisioDevKit.VgReferenced
      com.visioglobe.libVisioDevKit.VgINavigationInstruction

public class VgINavigationInstruction
extends VgReferenced

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

Class:

VgNavigationModule::VgINavigationInstruction

Field Summary

Fields inherited from class com.visioglobe.libVisioDevKit.VgReferenced

swigCMemOwn, swigRefPtr

Constructor Summary

VgINavigationInstruction(long cPtr, boolean cMemoryOwn)

Method Summary

void	delete()
protected void	finalize()
VgStringSet	getAttributes() Returns all the attributes of the traversed edges in a std::set.
static long	getCPtr(VgINavigationInstruction obj)
float	getDuration() Gets the duration.
float	getETA() Gets the estimated remaining time in seconds (at start of this instruction).
long	getIndex() Gets the index of the instruction, the index is 0-based, thus always less than VgINavigation->getNumInstructions().
VgPositionVector	getInstructionPositions() Returns all the intermediate positions of the instruction.
java.lang.String	getLayer() Gets the layer name of the instruction.
double	getLength() Gets the distance between start of this instruction to the start of the next instruction.
VgManeuverType	getManeuverType() Gets the maneuver type to perform at end of the instruction.
java.lang.String	getModality() Gets the name of the used modality.
VgNearPlaceVector	getNearPlaces() Get the PlaceIDs of places near the end of the instruction.
VgPosition	getPosition() Gets the position of the start of the instruction
float	getTime() Gets the time (not duration) relative to full route start.
float	getTotalTime() Gets the total duration of the route.
boolean	isEndOrTransitionPoint()

Methods inherited from class com.visioglobe.libVisioDevKit.VgReferenced

getCPtr, getNbReferences, ref, unref

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VgINavigationInstruction

public VgINavigationInstruction(long cPtr,
                                boolean cMemoryOwn)

Method Detail

getCPtr

public static long getCPtr(VgINavigationInstruction obj)

finalize

protected void finalize()

Overrides:

finalize in class VgReferenced

delete

public void delete()

Overrides:

delete in class VgReferenced

getLength

public double 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.

getManeuverType

public VgManeuverType getManeuverType()

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

Returns:

the maneuver type of the maneuver.

getLayer

public java.lang.String getLayer()

Gets the layer name of the instruction.

Returns:

The layer name of the instruction.

getModality

public java.lang.String getModality()

Gets the name of the used modality.

Returns:

The modality name of the instruction.

getTime

public float getTime()

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

Returns:

The time of the instruction from start of navigation in seconds

getTotalTime

public float getTotalTime()

Gets the total duration of the route.

Returns:

The total time of this instruction's route in seconds

getETA

public float getETA()

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

Returns:

The ETA of the instruction.

getDuration

public float getDuration()

Gets the duration.

Returns:

The duration of the instruction in seconds

getIndex

public long getIndex()

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

Returns:

index of the instruction.

getPosition

public VgPosition getPosition()

Gets the position of the start of the instruction

Returns:

Position of start of instruction.

getNearPlaces

public VgNearPlaceVector 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 VgINavigationRequestParameters::mNearPlacesThreshold at the time the navigation instructions where computed. It may be empty if there are no places that are closer than VgINavigationRequestParameters::mNearPlacesThreshold.

isEndOrTransitionPoint

public boolean 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.

getInstructionPositions

public VgPositionVector getInstructionPositions()

Returns all the intermediate positions of the instruction.

getAttributes

public VgStringSet getAttributes()

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