org.eclipse.kura.position

Interface PositionService

@ProviderType
public interface PositionService

This interface provides methods getting a geographic position. The OSGI Position class represents a geographic location, based on the WGS84 System (World Geodetic System 1984).

Position(Measurement lat, Measurement lon, Measurement alt, Measurement speed, Measurement track)

The interface also return a NmeaPosition, subclass of Position

See Also:

NmeaPosition, Position, Measurement

Method Summary

Modifier and Type	Method and Description
java.time.LocalDateTime	getDateTime() Returns the current date from PositionServiceProvider.
java.lang.String	getLastSentence() Deprecated. since version 2.3 Returns the last sentence received from the gps.
java.lang.String	getNmeaDate() Deprecated. Since 2.3 use getDateTime(). Access to underlying gps data layer is discouraged.
NmeaPosition	getNmeaPosition() Deprecated. Since 2.3 use getPosition(). Access to underlying gps data layer is discouraged.
java.lang.String	getNmeaTime() Deprecated. Since 2.3 use getDateTime(). Access to underlying gps data layer is discouraged.
org.osgi.util.position.Position	getPosition() Returns the current geographic position. The org.osgi.util.measurement.Measurement class is used to represent the values that make up a position: getLongitude() : returns the longitude of this position in radians.
boolean	isLocked() Returns true if a valid geographic position has been received.
void	registerListener(java.lang.String listenerId, PositionListener positionListener) Registers position listener
void	unregisterListener(java.lang.String listenerId) Unregisters position listener

Method Detail

getPosition

org.osgi.util.position.Position getPosition()

Returns the current geographic position.
The org.osgi.util.measurement.Measurement class is used to represent the values that make up a position:

• getLongitude() : returns the longitude of this position in radians. Can be null.
• getLatitude() : returns the latitude of this position in radians. Can be null.
• getSpeed() : returns the ground speed of this position in meters per second. Can be null.
• getTrack() : Returns the track of this position in radians as a compass heading. The track is the extrapolation of previous previously measured positions to a future position. Can be null.

See Also:

Position

getNmeaPosition

@Deprecated
NmeaPosition getNmeaPosition()

Deprecated. Since 2.3 use getPosition(). Access to underlying gps data layer is discouraged.

Returns the current NMEA geographic position.

• getLongitude() : returns the longitude of this position in degrees.
• getLatitude() : returns the latitude of this position in degrees.
• getSpeedKmh() : returns the ground speed of this position in km/h.
• getSpeedMph() : returns the ground speed of this position in mph.
• getTrack() : Returns the track of this position in degrees as a compass heading.

See Also:

NmeaPosition

getNmeaTime

@Deprecated
java.lang.String getNmeaTime()

Deprecated. Since 2.3 use getDateTime(). Access to underlying gps data layer is discouraged.

Returns the current NMEA time from GGA or ZDA sentence

Throws:

UnsupportedOperetaionException - PositionServiceProvider could not support this method.

getNmeaDate

@Deprecated
java.lang.String getNmeaDate()

Deprecated. Since 2.3 use getDateTime(). Access to underlying gps data layer is discouraged.

Returns the current NMEA date from ZDA sentence

Throws:

UnsupportedOperetaionException - PositionServiceProvider could not support this method.

getDateTime

java.time.LocalDateTime getDateTime()

Returns the current date from PositionServiceProvider. Returned DateTime is in UTC TimeZone.

Since:

2.3

isLocked

boolean isLocked()

Returns true if a valid geographic position has been received.

getLastSentence

@Deprecated
java.lang.String getLastSentence()

Deprecated. since version 2.3 Returns the last sentence received from the gps.

registerListener

void registerListener(java.lang.String listenerId,
                      PositionListener positionListener)

Registers position listener

Parameters:

listenerId - - listener ID as String

positionListener - - position listener as PositionListener

unregisterListener

void unregisterListener(java.lang.String listenerId)

Unregisters position listener

Parameters:

listenerId - - listener ID as String