fr.cnes.sirius.patrius.bodies

Class LLHCoordinates

java.lang.Object

fr.cnes.sirius.patrius.bodies.LLHCoordinates

All Implemented Interfaces:

Serializable

public class LLHCoordinates
extends Object
implements Serializable

This class aims at gathering in one single object the three coordinates latitude, longitude and height, and the associated coordinates system in which they are expressed. The user can define a name for the coordinates by using the dedicated constructeur LLHCoordinates(LLHCoordinatesSystem, double, double, double, String), otherwise the default value for the corresponding attribute is an empty String.

Author:

Alice Latourte

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LLHCoordinates(LLHCoordinatesSystem coordSystem, double latitude, double longitude, double height) Constructor.
LLHCoordinates(LLHCoordinatesSystem coordSystem, double latitude, double longitude, double height, String name) Constructor with name option.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
double	getHeight() Getter for the height in meters with respect to the shape surface.
double	getLatitude() Getter for the latitude.
LLHCoordinatesSystem	getLLHCoordinatesSystem() Getter for the used LLH coordinates system.
double	getLongitude() Getter for the longitude.
String	getName() Getter for the name of the coordinates.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LLHCoordinates

public LLHCoordinates(LLHCoordinatesSystem coordSystem,
                      double latitude,
                      double longitude,
                      double height)

Constructor. This constructor initializes name attribute with an empty String, to initialize this attribute with a user-defined value the constructor LLHCoordinates(LLHCoordinatesSystem, double, double, double, String) should be used instead.

Parameters:

coordSystem - coordinates system in which latitude, longitude and height coordinates are expressed

latitude - latitude coordinate

longitude - longitude coordinate

height - height coordinate (signed value)

LLHCoordinates

public LLHCoordinates(LLHCoordinatesSystem coordSystem,
                      double latitude,
                      double longitude,
                      double height,
                      String name)

Constructor with name option. This constructor enables the initialization of name attribute with a user-defined name.

Parameters:

coordSystem - coordinates system in which latitude, longitude and height coordinates are expressed

latitude - latitude coordinate

longitude - longitude coordinate

height - height coordinate (signed value)

name - name of coordinates

Method Detail

getLLHCoordinatesSystem

public LLHCoordinatesSystem getLLHCoordinatesSystem()

Getter for the used LLH coordinates system.

Returns:

the coordinates system

getLatitude

public double getLatitude()

Getter for the latitude.

Returns:

the latitude

getLongitude

public double getLongitude()

Getter for the longitude.

Returns:

the longitude

getHeight

public double getHeight()

Getter for the height in meters with respect to the shape surface. Following the convention, it can be the distance to shape (if normal height) or the radial height (if radial height). This is a signed value.

If the used height system is NORMAL, a positive value means the point is outside the shape, a negative value means the point is inside the shape.

Returns:

the height in meters

getName

public String getName()

Getter for the name of the coordinates. It returns an empty String if the user created object without using constructor with name option.

Returns:

the name of the coordinates.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object