net.maritimecloud.util.geometry

Class PositionReader

java.lang.Object

net.maritimecloud.util.geometry.PositionReader

public abstract class PositionReader
extends Object

A interface describing a way to get the current position (and timestamp of the reading) for an object.

Any implementations are not required to be thread safe.

Author:

Kasper Nielsen

See Also:

PositionReaderSimulator

Constructor Summary

Constructors

Constructor and Description
PositionReader()

Method Summary

Modifier and Type	Method and Description
static PositionReader	fixedPosition(Position position) Returns a reader that returns the same position every time.
static PositionReader	fixedPosition(PositionTime positionTime) Returns a reader that returns the same position and time every time.
static PositionReader	fromString(String pos)
abstract PositionTime	getCurrentPosition() Returns the current position and a timestamp for when the position was read.
static PositionReader	nativeReader() Returns a position reader that will return the current position on a native devices.

Methods inherited from class java.lang.Object

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

Constructor Detail

PositionReader

public PositionReader()

Method Detail

getCurrentPosition

public abstract PositionTime getCurrentPosition()

Returns the current position and a timestamp for when the position was read. The timestamp, measured in milliseconds, must be the difference between the current time and midnight, January 1, 1970 UTC.

Returns:

the current position and time

fixedPosition

public static PositionReader fixedPosition(Position position)

Returns a reader that returns the same position every time.

Parameters:

position - the position to return every time

Returns:

a new fixed position reader

fixedPosition

public static PositionReader fixedPosition(PositionTime positionTime)

Returns a reader that returns the same position and time every time.

Parameters:

positionTime - the position time to return every time

Returns:

a new fixed position reader

nativeReader

public static PositionReader nativeReader()

Returns a position reader that will return the current position on a native devices.

Returns:

a position reader that will return the current position on a native devices

Throws:

UnsupportedOperationException - if a native position reader is not available

fromString

public static PositionReader fromString(String pos)