fr.cnes.sirius.patrius.attitudes.directions

Class ToCelestialBodyCenterDirection

java.lang.Object

fr.cnes.sirius.patrius.attitudes.directions.ToCelestialBodyCenterDirection

All Implemented Interfaces:

IDirection, ITargetDirection, Serializable

public final class ToCelestialBodyCenterDirection
extends Object
implements ITargetDirection

Direction described by a celestial body : the celestial body's center is the target point.

Since:

1.1

Version:

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

Author:

Thomas Trapier

See Also:

Serialized Form

Concurrency :

conditionally thread-safe

Concurrency comment :

The use of a celestial body linked to the tree of frames makes this class thread-safe only if the underlying CelestialBody is too.

Constructor Summary

Constructors

Constructor and Description
ToCelestialBodyCenterDirection(CelestialBody inBody) Build a direction described by a celestial body : the celestial body's center is the target point.

Method Summary

Modifier and Type	Method and Description
Line	getLine(PVCoordinatesProvider origin, AbsoluteDate date, Frame frame) Provides the line containing the origin (given PV coordinates) and directed by the direction vector.
PVCoordinates	getTargetPVCoordinates(AbsoluteDate date, Frame frame) Provides the target point at a given date in a given frame, represented by the associated PVCoordinates object
Vector3D	getVector(PVCoordinatesProvider origin, 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

ToCelestialBodyCenterDirection

public ToCelestialBodyCenterDirection(CelestialBody inBody)

Build a direction described by a celestial body : the celestial body's center is the target point.

Parameters:

inBody - the celestial body

Method Detail

getVector

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

Provides the direction vector at a given date in a given frame.

Specified by:

getVector in interface IDirection

Parameters:

origin - the current coordinates of the origin point of the direction (may be null, in that specific case, the origin of the direction is the frame origin).

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

getTargetPVCoordinates

public PVCoordinates getTargetPVCoordinates(AbsoluteDate date,
                                            Frame frame)
                                     throws PatriusException

Provides the target point at a given date in a given frame, represented by the associated PVCoordinates object

Specified by:

getTargetPVCoordinates in interface ITargetDirection

Parameters:

date - the date

frame - the frame

Returns:

the PVCoordinates of the target

Throws:

PatriusException - if position cannot be computed in given frame

getLine

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

Provides the line containing the origin (given PV coordinates) and directed by the direction vector.

Specified by:

getLine in interface IDirection

Parameters:

origin - the origin of the direction

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