com.navigine.idl.java.RouteInstruction Class Reference

Next instruction for a guidance banner. More...

Public Member Functions
	RouteInstruction (RouteAnnotationType type, GlobalPoint point, Integer sublocationId, float distance, String title)
	Default constructor for class RouteInstruction.
RouteAnnotationType	getType ()
	Annotation kind (transition, maneuver, finish, …).
GlobalPoint	getPoint ()
	Instruction point in WGS84.
Integer	getSublocationId ()
	Floor id, or null when the instruction is outdoor.
float	getDistance ()
	Meters along the route from the current progress to this point.
String	getTitle ()
	Short label, when the annotation has one.
String	toString ()

Detailed Description

Next instruction for a guidance banner.

Built from the next RouteAnnotation ahead of the current route progress. distance is meters along the route, not a straight-line chord. This is a pedestrian manoeuvre (no lanes, signs, or road events).

Definition at line 19 of file RouteInstruction.java.

Constructor & Destructor Documentation

RouteInstruction()

com.navigine.idl.java.RouteInstruction.RouteInstruction ( RouteAnnotationType type, GlobalPoint point, Integer sublocationId, float distance, String title )

inline

Default constructor for class RouteInstruction.

Definition at line 35 of file RouteInstruction.java.

Member Function Documentation

getDistance()

float com.navigine.idl.java.RouteInstruction.getDistance ( )

inline

Meters along the route from the current progress to this point.

Returns

Definition at line 72 of file RouteInstruction.java.

getPoint()

GlobalPoint com.navigine.idl.java.RouteInstruction.getPoint ( )

inline

Instruction point in WGS84.

Returns

Definition at line 58 of file RouteInstruction.java.

getSublocationId()

Integer com.navigine.idl.java.RouteInstruction.getSublocationId ( )

inline

Floor id, or null when the instruction is outdoor.

Returns

Definition at line 65 of file RouteInstruction.java.

getTitle()

String com.navigine.idl.java.RouteInstruction.getTitle ( )

inline

Short label, when the annotation has one.

Returns

Definition at line 79 of file RouteInstruction.java.

getType()

RouteAnnotationType com.navigine.idl.java.RouteInstruction.getType ( )

inline

Annotation kind (transition, maneuver, finish, …).

Returns

Definition at line 51 of file RouteInstruction.java.

toString()

String com.navigine.idl.java.RouteInstruction.toString ( )

inline

Definition at line 84 of file RouteInstruction.java.

---

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

• RouteInstruction.java