fr.cnes.sirius.patrius.attitudes.directions

Class VelocityDirection

java.lang.Object

fr.cnes.sirius.patrius.attitudes.directions.VelocityDirection

All Implemented Interfaces:

IDirection

public final class VelocityDirection
extends Object
implements IDirection

Direction defined for any PVCoordinatesProvider origin by its velocity vector, expressed in a reference frame (parameter of the constructor). The vector is then only projected in the input frame of the getVector or getLine methods.

Since:

1.1

Version:

$Id: VelocityDirection.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
VelocityDirection(Frame referenceFrame) Build a Direction defined for any PVCoordinatesProvider origin by its velocity vector with respect to a reference frame.

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.
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

VelocityDirection

public VelocityDirection(Frame referenceFrame)

Build a Direction defined for any PVCoordinatesProvider origin by its velocity vector with respect to a reference frame.

Parameters:

referenceFrame - the reference expression frame of the velocity vector

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

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