Position (MaritimeCloud API)

java.lang.Object
- net.maritimecloud.util.geometry.Position

All Implemented Interfaces:

Serializable, Message

Direct Known Subclasses:

PositionTime
```
public class Position
extends Object
implements Message, Serializable
```
Representation of a WGS84 position and methods for calculating range and bearing between positions.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static MessageSerializer<Position> SERIALIZER

Fields
Modifier and Type	Field and Description
`static MessageSerializer<Position>`	`SERIALIZER`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Position`	`create(double latitude, double longitude)` Creates a new position from the specified latitude and longitude.
`boolean`	`equals(Object other)` Equals method
`boolean`	`equals(Position other)`
`static Position`	`fromBinary(Binary b)` Returns a position from a 64 bit byte array encoded as decimal degress with 7 decimal places.
`static Position`	`fromPackedLong(long l)`
`double`	`geodesicDistanceTo(Position other)` Returns the great circle distance to the specified position.
`double`	`geodesicFinalBearingTo(Position other)` Calculate final bearing for great circle route to location using Thaddeus Vincenty's inverse formula.
`double`	`geodesicInitialBearingTo(Position other)` Calculate initial bearing for great circle route to location using Thaddeus Vincenty's inverse formula.
`long`	`getCell(double degress)`
`int`	`getCellInt(double degress)`
`double`	`getLatitude()` Returns the latitude part of this position.
`String`	`getLatitudeAsString()`
`double`	`getLongitude()` Returns the longitude part of this position.
`String`	`getLongitudeAsString()`
`int`	`hashCode()` Hash code for the location
`Position`	`immutable()` Returns an immutable copy of this message.
`static boolean`	`isValid(double latitude, double longitude)`
`static Position`	`random()` Returns a random valid position.
`static Position`	`random(Random rnd)` Returns a random valid position.
`double`	`rhumbLineBearingTo(Position position)` Calculates the rhumb line bearing to the specified position
`double`	`rhumbLineDistanceTo(Position other)`
`Binary`	`toBinary()` Returns a 64 bit representation of this position.
`String`	`toJSON()` Returns a JSON representation of this message
`long`	`toPackedLong()` Packs the position into a long (losing some precision).
`String`	`toString()`
`String`	`toStringDegrees()`
`static double`	`verifyLatitude(double latitude)` Verify that latitude is within the interval [-90:90].
`static double`	`verifyLongitude(double longitude)` Verify that longitude is within the interval [-180:180].
`Position`	`withLatitude(double latitude)` Returns a new position with the same longitude as this position but with the specified latitude.
`Position`	`withLongitude(double longitude)` Returns a new position with the same latitude as this position but with the specified longitude.
`PositionTime`	`withTime(long time)` Returns a new position time with this position added with the current time.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZER
```
public static final MessageSerializer<Position> SERIALIZER
```
- Method Detail
  - equals
```
public boolean equals(Object other)
```
    Equals method
    
    Overrides:
    
    equals in class Object
  - equals
```
public boolean equals(Position other)
```
  - geodesicDistanceTo
```
public double geodesicDistanceTo(Position other)
```
    Returns the great circle distance to the specified position.
    
    Parameters:
    
    other - the position to calculate the distance from
    
    Returns:
    
    distance in meters
  - geodesicFinalBearingTo
```
public double geodesicFinalBearingTo(Position other)
```
    Calculate final bearing for great circle route to location using Thaddeus Vincenty's inverse formula.
    
    Parameters:
    
    other - the position to calculate the bearing from
    
    Returns:
    
    bearing in degrees
  - geodesicInitialBearingTo
```
public double geodesicInitialBearingTo(Position other)
```
    Calculate initial bearing for great circle route to location using Thaddeus Vincenty's inverse formula.
    
    Parameters:
    
    other - the position to calculate the bearing from
    
    Returns:
    
    bearing in degrees
  - getCell
```
public long getCell(double degress)
```
  - getCellInt
```
public int getCellInt(double degress)
```
  - getLatitude
```
public double getLatitude()
```
    Returns the latitude part of this position.
    
    Returns:
    
    the latitude part of this position
  - getLatitudeAsString
```
public String getLatitudeAsString()
```
  - getLongitude
```
public double getLongitude()
```
    Returns the longitude part of this position.
    
    Returns:
    
    the longitude part of this position
  - getLongitudeAsString
```
public String getLongitudeAsString()
```
  - hashCode
```
public int hashCode()
```
    Hash code for the location
    
    Overrides:
    
    hashCode in class Object
  - immutable
```
public Position immutable()
```
    Returns an immutable copy of this message.
    
    Specified by:
    
    immutable in interface Message
    
    Returns:
    
    an immutable copy of this message
  - rhumbLineBearingTo
```
public double rhumbLineBearingTo(Position position)
```
    Calculates the rhumb line bearing to the specified position
    
    Parameters:
    
    position - the position
    
    Returns:
    
    the rhumb line bearing in degrees
  - rhumbLineDistanceTo
```
public double rhumbLineDistanceTo(Position other)
```
  - toJSON
```
public String toJSON()
```
    Returns a JSON representation of this message
    
    Specified by:
    
    toJSON in interface Message
    
    Returns:
    
    a JSON representation of this message
  - toPackedLong
```
public long toPackedLong()
```
    Packs the position into a long (losing some precision). Can be read later by fromPackedLong(long)
    
    Returns:
    
    the packet long
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toStringDegrees
```
public String toStringDegrees()
```
  - withLatitude
```
public Position withLatitude(double latitude)
```
    Returns a new position with the same longitude as this position but with the specified latitude.
    
    Parameters:
    
    latitude - the new latitude for the new position
    
    Returns:
    
    the new position
  - withLongitude
```
public Position withLongitude(double longitude)
```
    Returns a new position with the same latitude as this position but with the specified longitude.
    
    Parameters:
    
    longitude - the new longitude for the new position
    
    Returns:
    
    the new position
  - withTime
```
public PositionTime withTime(long time)
```
    Returns a new position time with this position added with the current time.
    
    Parameters:
    
    time - the time of the new position time object
    
    Returns:
    
    the new position time object
  - create
```
public static Position create(double latitude,
                              double longitude)
```
    Creates a new position from the specified latitude and longitude.
    
    Parameters:
    
    latitude - the latitude
    
    longitude - the longitude
    
    Returns:
    
    the new position
    
    Throws:
    
    IllegalArgumentException - if the
  - fromBinary
```
public static Position fromBinary(Binary b)
```
    Returns a position from a 64 bit byte array encoded as decimal degress with 7 decimal places.
    
    Returns:
    
    the position from a binary array
  - toBinary
```
public Binary toBinary()
```
    Returns a 64 bit representation of this position. Encoded as decimal degress with 7 decimal places.
    
    Returns:
    
    the position as a binary
  - fromPackedLong
```
public static Position fromPackedLong(long l)
```
  - isValid
```
public static boolean isValid(double latitude,
                              double longitude)
```
    Parameters:
    
    latitude - the latitude
    
    longitude - the longitude
    
    Returns:
    
    whether or not the specified latitude and longitude is valid
  - random
```
public static Position random()
```
    Returns a random valid position.
    
    Returns:
    
    the random position
  - random
```
public static Position random(Random rnd)
```
    Returns a random valid position.
    
    Parameters:
    
    rnd - the source of randomness
    
    Returns:
    
    the random position
  - verifyLatitude
```
public static double verifyLatitude(double latitude)
```
    Verify that latitude is within the interval [-90:90].
    
    Parameters:
    
    latitude - the latitude to verify
    
    Returns:
    
    the specified latitude
    
    Throws:
    
    IllegalArgumentException - When latitude is invalid
  - verifyLongitude
```
public static double verifyLongitude(double longitude)
```
    Verify that longitude is within the interval [-180:180].
    
    Parameters:
    
    longitude - the longitude to verify
    
    Returns:
    
    the specified longitude
    
    Throws:
    
    IllegalArgumentException - When longitude is invalid

Class Position

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZER

Method Detail

equals

equals

geodesicDistanceTo

geodesicFinalBearingTo

geodesicInitialBearingTo

getCell

getCellInt

getLatitude

getLatitudeAsString

getLongitude

getLongitudeAsString

hashCode

immutable

rhumbLineBearingTo

rhumbLineDistanceTo

toJSON

toPackedLong

toString

toStringDegrees

withLatitude

withLongitude

withTime

create

fromBinary

toBinary

fromPackedLong

isValid

random

random

verifyLatitude

verifyLongitude