fr.cnes.sirius.patrius.frames

Class TwoDirectionFrame

java.lang.Object

fr.cnes.sirius.patrius.frames.Frame

fr.cnes.sirius.patrius.frames.TwoDirectionFrame

All Implemented Interfaces:

PVCoordinatesProvider, Serializable

public class TwoDirectionFrame
extends Frame

Class for frames built with two directions and the two axes they correspond to.

Author:

Mathilde Lefevre

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TwoDirectionFrame(Frame parentFrame, PVCoordinatesProvider provider, String nameIn, IDirection firstDir, IDirection secondDir, Vector3D frameFirstAxis, Vector3D frameSecondAxis) Build a new instance with default finite difference delta value
TwoDirectionFrame(Frame parentFrame, PVCoordinatesProvider provider, String nameIn, IDirection firstDir, IDirection secondDir, Vector3D frameFirstAxis, Vector3D frameSecondAxis, double dH) Build a new instance.

Method Summary

Modifier and Type	Method and Description
Vector3D	getAxisOne()
Vector3D	getAxisTwo()
IDirection	getDirectionOne()
IDirection	getDirectionTwo()

Methods inherited from class fr.cnes.sirius.patrius.frames.Frame

getAncestor, getDepth, getFirstCommonPseudoInertialAncestor, getFirstPseudoInertialAncestor, getFrozenFrame, getFrozenFrame, getName, getNativeFrame, getParent, getPVCoordinates, getRoot, getTransformJacobian, getTransformProvider, getTransformTo, getTransformTo, getTransformTo, getTransformTo, isChildOf, isPseudoInertial, setName, setReferential, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TwoDirectionFrame

public TwoDirectionFrame(Frame parentFrame,
                         PVCoordinatesProvider provider,
                         String nameIn,
                         IDirection firstDir,
                         IDirection secondDir,
                         Vector3D frameFirstAxis,
                         Vector3D frameSecondAxis)

Build a new instance with default finite difference delta value

Parameters:

parentFrame - parent frame. The frame is defined relatively to this parent frame. Parent frame is usually inertial or quasi-inertial, although non-inertial frame can also be used.

provider - state provider used to compute frame motion. Frame origin from which the directions are computed

nameIn - name of the frame

firstDir - the first direction that defines the frame

secondDir - the second direction that defines the frame

frameFirstAxis - the axis of the frame the first direction has to correspond to

frameSecondAxis - the axis of the frame the second direction has to correspond to

Throws:

IllegalArgumentException - if the parent frame is null

TwoDirectionFrame

public TwoDirectionFrame(Frame parentFrame,
                         PVCoordinatesProvider provider,
                         String nameIn,
                         IDirection firstDir,
                         IDirection secondDir,
                         Vector3D frameFirstAxis,
                         Vector3D frameSecondAxis,
                         double dH)

Build a new instance.

Parameters:

parentFrame - parent frame. The frame is defined relatively to this parent frame. Parent frame is usually inertial or quasi-inertial, although non-inertial frame can also be used.

provider - state provider used to compute frame motion. Frame origin from which the directions are computed

nameIn - name of the frame

firstDir - the first direction that defines the frame

secondDir - the second direction that defines the frame

frameFirstAxis - the axis of the frame the first direction has to correspond to

frameSecondAxis - the axis of the frame the second direction has to correspond to

dH - Finite difference delta value to compute the rotation rate in the direction frame provider (1 s by default)

Throws:

IllegalArgumentException - if the parent frame is null

Method Detail

getDirectionOne

public IDirection getDirectionOne()

Returns:

the directionOne

getDirectionTwo

public IDirection getDirectionTwo()

Returns:

the directionTwo

getAxisOne

public Vector3D getAxisOne()

Returns:

the axisOne

getAxisTwo

public Vector3D getAxisTwo()

Returns:

the axisTwo