jme3tools.navigation

Class Position

java.lang.Object

jme3tools.navigation.Position

public class Position
extends java.lang.Object

This class represents the position of an entity in the world.

Since:

1.0

Author:

Benjamin Jakobus (based on JMarine by Cormac Gebruers and Benjamin Jakobus)

Constructor Summary

Constructors

Constructor and Description
Position(double dblLat, double dblLng) A new position expressed in decimal format
Position(int latDeg, float latMin, int latQuad, int lngDeg, float lngMin, int lngQuad) A new position expressed in DegMin format
Position(java.lang.String lat, java.lang.String lng) A new position expressed in ALRS format
Position(java.lang.String latNMEAGPS, java.lang.String latQuad, java.lang.String lngNMEAGPS, java.lang.String lngQuad, java.lang.String utcTimeStamp) A new position expressed in NMEA GPS message format: 4807.038,N,01131.000,E

Method Summary

Modifier and Type	Method and Description
void	associateUTCTime(java.lang.String data) Add a reference time for this position - useful for historical tracking
double	getLatitude() Return the position latitude in decimal format
double	getLongitude() Return the position longitude in decimal format
static void	main(java.lang.String[] argsc)
java.lang.String	toStringDec() Prints out position using decimal format
java.lang.String	toStringDecLat() Prints out the position latitude
java.lang.String	toStringDecLng() Prints out the position longitude
java.lang.String	toStringDegMin() Prints out position using DegMin format
java.lang.String	toStringDegMinLat() Prints out the position latitude
java.lang.String	toStringDegMinLng() Prints out the position longitude
java.lang.String	utcTimeStamp() Returns the UTC time stamp

Methods inherited from class java.lang.Object

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

Constructor Detail

Position

public Position(double dblLat,
                double dblLng)
         throws InvalidPositionException

A new position expressed in decimal format

Parameters:

dblLat -

dblLng -

Throws:

InvalidPositionException

Since:

1.0

Position

public Position(int latDeg,
                float latMin,
                int latQuad,
                int lngDeg,
                float lngMin,
                int lngQuad)
         throws InvalidPositionException

A new position expressed in DegMin format

Parameters:

latDeg -

latMin -

lngDeg -

lngMin -

Throws:

InvalidPositionException

Since:

1.0

Position

public Position(java.lang.String lat,
                java.lang.String lng)
         throws InvalidPositionException

A new position expressed in ALRS format

Parameters:

lat -

lng -

Throws:

InvalidPositionException

Since:

1.0

Position

public Position(java.lang.String latNMEAGPS,
                java.lang.String latQuad,
                java.lang.String lngNMEAGPS,
                java.lang.String lngQuad,
                java.lang.String utcTimeStamp)

A new position expressed in NMEA GPS message format: 4807.038,N,01131.000,E

Parameters:

latNMEAGPS -

latQuad -

lngNMEAGPS -

lngQuad -

utcTimeStamp -

Since:

12.0

Method Detail

associateUTCTime

public void associateUTCTime(java.lang.String data)

Add a reference time for this position - useful for historical tracking

Parameters:

data -

Since:

1.0

utcTimeStamp

public java.lang.String utcTimeStamp()

Returns the UTC time stamp

Returns:

str the UTC timestamp

Since:

1.0

toStringDec

public java.lang.String toStringDec()

Prints out position using decimal format

Returns:

the position in decimal format

getLatitude

public double getLatitude()

Return the position latitude in decimal format

Returns:

the latitude in decimal format

Since:

1.0

getLongitude

public double getLongitude()

Return the position longitude in decimal format

Returns:

the longitude in decimal format

Since:

1.0

toStringDegMin

public java.lang.String toStringDegMin()

Prints out position using DegMin format

Returns:

the position in DegMin Format

Since:

1.0

toStringDegMinLat

public java.lang.String toStringDegMinLat()

Prints out the position latitude

Returns:

the latitude as a string for display purposes

Since:

1.0

toStringDegMinLng

public java.lang.String toStringDegMinLng()

Prints out the position longitude

Returns:

the longitude as a string for display purposes

Since:

1.0

toStringDecLat

public java.lang.String toStringDecLat()

Prints out the position latitude

Returns:

the latitude as a string for display purposes

Since:

1.0

toStringDecLng

public java.lang.String toStringDecLng()

Prints out the position longitude

Returns:

the longitude as a string for display purposes

Since:

1.0

main

public static void main(java.lang.String[] argsc)