fr.cnes.sirius.patrius.attitudes

Class AttitudeTransformProvider

java.lang.Object

fr.cnes.sirius.patrius.attitudes.AttitudeTransformProvider

All Implemented Interfaces:

TransformProvider, Serializable

public class AttitudeTransformProvider
extends Object
implements TransformProvider

This class is a TransformProvider for AttitudeFrame; it provides, for a given date, the transformation corresponding to the spacecraft reference frame orientation with respect to the parent frame.

Spin derivative is computed when required and correspond to spin derivative of underlying attitude provider.

Frames configuration is unused.

Since:

1.2

Version:

$Id$

Author:

tournebizej

See Also:

AttitudeFrame, Serialized Form

Concurrency :

conditionally thread-safe

Concurrency comment :

is thread-safe if all attributes are.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AttitudeTransformProvider(AttitudeProvider attProvider, PVCoordinatesProvider pv, Frame frame) Protected constructor.

Method Summary

Modifier and Type	Method and Description
Transform	getTransform(AbsoluteDate date) Get the Transform corresponding to specified date.
Transform	getTransform(AbsoluteDate date, boolean computeSpinDerivatives) Get the Transform corresponding to specified date.
Transform	getTransform(AbsoluteDate date, FramesConfiguration config) Get the Transform corresponding to specified date.
Transform	getTransform(AbsoluteDate date, FramesConfiguration config, boolean computeSpinDerivatives) Get the Transform corresponding to specified date.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttitudeTransformProvider

protected AttitudeTransformProvider(AttitudeProvider attProvider,
                                    PVCoordinatesProvider pv,
                                    Frame frame)

Protected constructor.

Parameters:

attProvider - the attitude provider from which the transformation with respect to a parent frame is computed.

pv - the PV coordinates provider.

frame - the parent frame.

Method Detail

getTransform

public Transform getTransform(AbsoluteDate date,
                              boolean computeSpinDerivatives)
                       throws PatriusException

Get the Transform corresponding to specified date.

Spin derivative is computed when required and correspond to spin derivative of underlying attitude provider.

Specified by:

getTransform in interface TransformProvider

Parameters:

date - current date

computeSpinDerivatives - true if spin derivatives should be computed. If not, spin derivative is set to null

Returns:

transform at specified date

Throws:

PatriusException - if transform cannot be computed at given date

getTransform

public Transform getTransform(AbsoluteDate date)
                       throws PatriusException

Get the Transform corresponding to specified date.

Warning: spin derivative is not computed.

Specified by:

getTransform in interface TransformProvider

Parameters:

date - current date

Returns:

transform at specified date

Throws:

PatriusException - if transform cannot be computed at given date

getTransform

public Transform getTransform(AbsoluteDate date,
                              FramesConfiguration config)
                       throws PatriusException

Get the Transform corresponding to specified date.

Warning: spin derivative is not computed.

Frames configuration is unused.

Specified by:

getTransform in interface TransformProvider

Parameters:

date - current date

config - frames configuration to use

Returns:

transform at specified date

Throws:

PatriusException - if transform cannot be computed at given date

getTransform

public Transform getTransform(AbsoluteDate date,
                              FramesConfiguration config,
                              boolean computeSpinDerivatives)
                       throws PatriusException

Get the Transform corresponding to specified date.

Spin derivative is computed when required and correspond to spin derivative of underlying attitude provider.

Frames configuration is unused.

Specified by:

getTransform in interface TransformProvider

Parameters:

date - current date

config - frames configuration to use

computeSpinDerivatives - true if spin derivatives should be computed. If not, spin derivative is set to null

Returns:

transform at specified date

Throws:

PatriusException - if transform cannot be computed at given date