fr.cnes.sirius.patrius.attitudes.directions

Interface IDirection

All Superinterfaces:

Serializable

All Known Subinterfaces:

ITargetDirection

All Known Implementing Classes:

BasicBoardSun, BodyPointTargetDirection, CelestialBodyPolesAxisDirection, ConstantVectorDirection, CrossProductDirection, EarthCenterDirection, EarthToCelestialPointDirection, GenericTargetDirection, GlintApproximatePointingDirection, GroundVelocityDirection, MomentumDirection, NadirDirection, NorthNormalToEclipticDirection, ToCelestialPointDirection, VelocityDirection

public interface IDirection
extends Serializable

This is the main interface for directions.

Since:

1.1

Version:

$Id: IDirection.java 18065 2017-10-02 16:42:02Z bignon $

Author:

Thomas Trapier

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.

Method Detail

getVector

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

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

Parameters:

pvCoord - 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 (from origin to target) at the given date in the given frame

Throws:

PatriusException - if some frame specific errors occur

getLine

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.

Parameters:

pvCoord - the origin of the direction

date - the current date

frame - the expression frame of the line

Returns:

the half Line of space from the origin position at given date and containing the direction vector

Throws:

PatriusException - if some frame specific errors occur