fr.cnes.sirius.patrius.attitudes.directions

Class GenericTargetDirection

java.lang.Object

fr.cnes.sirius.patrius.attitudes.directions.GenericTargetDirection

All Implemented Interfaces:

IDirection, ITargetDirection

public final class GenericTargetDirection
extends Object
implements ITargetDirection

Direction described by a target PVCoordinatesProvider. The vector is at any date computed from the given PVCoordinate origin to the target.

Since:

1.1

Version:

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

Author:

Thomas Trapier

Concurrency :

not thread-safe

Concurrency comment :

Not thread-safe by default. No use case for sharing an instance between threads found.

Constructor Summary

Constructors

Constructor and Description
GenericTargetDirection(PVCoordinatesProvider inTarget) Build a direction from a target described by its PVCoordinatesProvider

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

GenericTargetDirection

public GenericTargetDirection(PVCoordinatesProvider inTarget)

Build a direction from a target described by its PVCoordinatesProvider

Parameters:

inTarget - the PVCoordinatesProvider describing the target point

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