Package com.navmii.sdk.routecalculation

Class RoutePlanPoint

java.lang.Object

com.navmii.sdk.routecalculation.RoutePlanPoint

public abstract class RoutePlanPoint
extends java.lang.Object

Interface describing route plan point.

Constructor Summary

Constructors

Constructor	Description
RoutePlanPoint()

Method Summary

Modifier and Type	Method	Description
abstract MapCoordinates	coordinates()	Route plan point geo coordinates.
abstract float	course()	Route plan point course from North clockwise.
static RoutePlanPoint	createWithCoordinates(MapCoordinates coordinates)	Creates route plan point with the specified coordinates.
static RoutePlanPoint	createWithCoordinatesAndCourse(MapCoordinates coordinates, float course)	Creates route plan point with the specified coordinates and course.
static RoutePlanPoint	createWithPosition(Position position)	Creates object using the specified position.
abstract boolean	snapped()	Indicates whether route plan point considered as snapped.

Methods inherited from class java.lang.Object

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

Constructor Details

RoutePlanPoint

public RoutePlanPoint()

Method Details

snapped

public abstract boolean snapped()

Indicates whether route plan point considered as snapped. The only way to initialize a snapped route plan point is to construct it from a snapped position using 'createWithPosition' method.

coordinates

public abstract MapCoordinates coordinates()

Route plan point geo coordinates.

course

public abstract float course()

Route plan point course from North clockwise. [0..360). If course is not available -1.0f is returned.

createWithCoordinates

public static RoutePlanPoint createWithCoordinates(MapCoordinates coordinates)

Creates route plan point with the specified coordinates. If route plan point was initialized using this method, #course returns default -1.0f value. Route plan point is not snapped, therefore snapped method returns 'false'.

Parameters:

coordinates - Route plan point geo coordinates.

createWithCoordinatesAndCourse

public static RoutePlanPoint createWithCoordinatesAndCourse(MapCoordinates coordinates, float course)

Creates route plan point with the specified coordinates and course. Route plan point is not snapped, therefore snapped method returns 'false'.

Parameters:

coordinates - Route plan point geo coordinates;

course - Route plan point course from North clockwise. [0..360).

createWithPosition

public static RoutePlanPoint createWithPosition(Position position)

Creates object using the specified position.

Parameters:

position - Position to initialize route plan point with.