fr.cnes.sirius.patrius.bodies

Class GeodeticPoint

java.lang.Object

fr.cnes.sirius.patrius.bodies.GeodeticPoint

All Implemented Interfaces:

Serializable

public class GeodeticPoint
extends Object
implements Serializable

Point location relative to a 2D body surface. Note : this object is not intrinsically linked to a BodyShape.

Instance of this class are guaranteed to be immutable.

Author:

Luc Maisonobe

See Also:

BodyShape, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GeodeticPoint(double latitudeIn, double longitudeIn, double altitudeIn) Build a new instance.
GeodeticPoint(double latitudeIn, double longitudeIn, double altitudeIn, String nameIn) Build a new instance.

Method Summary

Modifier and Type	Method and Description
double	getAltitude() Get the altitude.
Vector3D	getEast() Get the direction to the east of point, expressed in parent shape frame.
double	getLatitude() Get the geodetic latitude.
double	getLongitude() Get the longitude.
Vector3D	getNadir() Get the direction below the point, expressed in parent shape frame.
String	getName() Getter for the name of the point.
Vector3D	getNorth() Get the direction to the north of point, expressed in parent shape frame.
Vector3D	getSouth() Get the direction to the south of point, expressed in parent shape frame.
Vector3D	getWest() Get the direction to the west of point, expressed in parent shape frame.
Vector3D	getZenith() Get the direction above the point, expressed in parent shape frame.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GeodeticPoint

public GeodeticPoint(double latitudeIn,
                     double longitudeIn,
                     double altitudeIn)

Build a new instance.

Parameters:

latitudeIn - of the point

longitudeIn - longitude of the point

altitudeIn - altitude of the point

GeodeticPoint

public GeodeticPoint(double latitudeIn,
                     double longitudeIn,
                     double altitudeIn,
                     String nameIn)

Build a new instance.

Parameters:

latitudeIn - of the point

longitudeIn - longitude of the point

altitudeIn - altitude of the point

nameIn - name of the point

Method Detail

getLatitude

public double getLatitude()

Get the geodetic latitude. To get planetocentric latitude use SphericalCoordinates class instead of GeodeticPoint.

Returns:

latitude

getLongitude

public double getLongitude()

Get the longitude.

Returns:

longitude

getAltitude

public double getAltitude()

Get the altitude.

Returns:

altitude

getZenith

public Vector3D getZenith()

Get the direction above the point, expressed in parent shape frame.

The zenith direction is defined as the normal to local horizontal plane.

Returns:

unit vector in the zenith direction

See Also:

getNadir()

getNadir

public Vector3D getNadir()

Get the direction below the point, expressed in parent shape frame.

The nadir direction is the opposite of zenith direction.

Returns:

unit vector in the nadir direction

See Also:

getZenith()

getNorth

public Vector3D getNorth()

Get the direction to the north of point, expressed in parent shape frame.

The north direction is defined in the horizontal plane (normal to zenith direction) and following the local meridian.

Returns:

unit vector in the north direction

See Also:

getSouth()

getSouth

public Vector3D getSouth()

Get the direction to the south of point, expressed in parent shape frame.

The south direction is the opposite of north direction.

Returns:

unit vector in the south direction

See Also:

getNorth()

getEast

public Vector3D getEast()

Get the direction to the east of point, expressed in parent shape frame.

The east direction is defined in the horizontal plane in order to complete direct triangle (east, north, zenith).

Returns:

unit vector in the east direction

See Also:

getWest()

getWest

public Vector3D getWest()

Get the direction to the west of point, expressed in parent shape frame.

The west direction is the opposite of east direction.

Returns:

unit vector in the west direction

See Also:

getEast()

getName

public String getName()

Getter for the name of the point.

Returns:

the name of the point.

toString

public String toString()

Overrides:

toString in class Object