fr.cnes.sirius.patrius.attitudes.orientations

Class OrientationAngleTransform

java.lang.Object

fr.cnes.sirius.patrius.attitudes.orientations.OrientationAngleTransform

All Implemented Interfaces:

TransformStateProvider, Serializable

public class OrientationAngleTransform
extends Object
implements TransformStateProvider

One degree of liberty transform provider. It is defined by:

• A reference transform which provides a reference orientation of the part
• An axis which provides the rotation axis of the part
• An OrientationAngleProvider which provides an angle through time

Since:

4.4

Author:

Emmanuel Bignon

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OrientationAngleTransform(Transform reference, Vector3D axis, OrientationAngleProvider orientationAngleProvider) Constructor.

Method Summary

Modifier and Type	Method and Description
Vector3D	getAxis() Returns the axis of the transform in the frame defined by the reference transform.
OrientationAngleProvider	getOrientationAngleProvider() The orientation angle provider which provides an angle through time.
Transform	getReference() Returns the reference transform.
Transform	getTransform(SpacecraftState state) Get the Transform corresponding to specified state.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrientationAngleTransform

public OrientationAngleTransform(Transform reference,
                                 Vector3D axis,
                                 OrientationAngleProvider orientationAngleProvider)

Constructor.

Parameters:

reference - reference transformation

axis - axis of degree of liberty

orientationAngleProvider - orientation angle provider

Method Detail

getTransform

public Transform getTransform(SpacecraftState state)
                       throws PatriusException

Get the Transform corresponding to specified state.

Specified by:

getTransform in interface TransformStateProvider

Parameters:

state - state

Returns:

transform with specified state

Throws:

PatriusException - thrown if transform cannot be computed

getReference

public Transform getReference()

Returns the reference transform. This is the transform return by the getTransform(SpacecraftState) method if the orientation angle is 0.

Returns:

the reference transform

getAxis

public Vector3D getAxis()

Returns the axis of the transform in the frame defined by the reference transform.

Returns:

the axis of the transform

getOrientationAngleProvider

public OrientationAngleProvider getOrientationAngleProvider()

The orientation angle provider which provides an angle through time. The final transform is the reference transform + rotation around getAxis().

Returns:

the orientation angle provider which provides an angle through time