fr.cnes.sirius.patrius.attitudes.directions

Class CelestialBodyPolesAxisDirection

java.lang.Object

fr.cnes.sirius.patrius.attitudes.directions.CelestialBodyPolesAxisDirection

All Implemented Interfaces:

IDirection, Serializable

public final class CelestialBodyPolesAxisDirection
extends Object
implements IDirection

This direction is the axis defined by the two poles of a celestial body.

Since:

1.1

Version:

$Id: CelestialBodyPolesAxisDirection.java 17582 2017-05-10 12:58:16Z bignon $

Author:

Thomas Trapier

See Also:

Serialized Form

Concurrency :

conditionally thread-safe

Concurrency comment :

this class is thread-safe only if the underlying CelestialBody is too.

Constructor Summary

Constructors

Constructor and Description
CelestialBodyPolesAxisDirection(CelestialBody inBody) Build a direction defined by the frame associated to a celestial body.

Method Summary

Modifier and Type	Method and Description
Line	getLine(PVCoordinatesProvider pvCoord, AbsoluteDate date, Frame frame) Provides the line containing the origin (given PV coordinates) and directed by the direction vector.
Vector3D	getVector(PVCoordinatesProvider pvCoord, AbsoluteDate date, Frame frame) Provides the direction vector at a given date in a given frame.

Methods inherited from class java.lang.Object

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

Constructor Detail

CelestialBodyPolesAxisDirection

public CelestialBodyPolesAxisDirection(CelestialBody inBody)

Build a direction defined by the frame associated to a celestial body. The vector is the Z axis of its oriented frame.

Parameters:

inBody - the celestial body associated to the orbit

Method Detail

getVector

public Vector3D getVector(PVCoordinatesProvider pvCoord,
                          AbsoluteDate date,
                          Frame frame)
                   throws PatriusException

Provides the direction vector at a given date in a given frame. This Direction has no origin, so the pv coordinates are unused.

Specified by:

getVector in interface IDirection

Parameters:

pvCoord - UNUSED : null is accepted

date - the date

frame - the frame to project the vector's coordinates

Returns:

the direction vector at the given date in the given frame

Throws:

PatriusException - if some frame specific errors occur

getLine

public Line getLine(PVCoordinatesProvider pvCoord,
                    AbsoluteDate date,
                    Frame frame)
             throws PatriusException

Provides the line containing the origin (given PV coordinates) and directed by the direction vector. This Direction has no origin, so the pv coordinates are unused.

Specified by:

getLine in interface IDirection

Parameters:

pvCoord - UNUSED : null is accepted

date - the current date

frame - the expression frame of the line

Returns:

the Line of space containing the origin and direction vector

Throws:

PatriusException - if some frame specific errors occur