fr.cnes.sirius.patrius.attitudes

Class OrientationTransformProvider

java.lang.Object

fr.cnes.sirius.patrius.attitudes.OrientationTransformProvider

All Implemented Interfaces:

TransformProvider, Serializable

public class OrientationTransformProvider
extends Object
implements TransformProvider

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

Spin derivative is never computed and is either 0 or null. No analytical formula is available for spin derivative. Spin is already computed by finite differences.

Frames configuration is unused.

Since:

1.2

Version:

$Id$

Author:

tournebizej

See Also:

OrientationFrame, Serialized Form

Concurrency :

conditionally thread-safe

Concurrency comment :

thread-safe if all attributes are.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OrientationTransformProvider(IOrientationLaw law, Frame frame) Protected constructor.
protected	OrientationTransformProvider(IOrientationLaw law, Frame frame, double spinDeltaT) 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

OrientationTransformProvider

protected OrientationTransformProvider(IOrientationLaw law,
                                       Frame frame)

Protected constructor.

Parameters:

law - the orientation law from which the transformation with respect to a parent frame is computed.

frame - the parent frame.

OrientationTransformProvider

protected OrientationTransformProvider(IOrientationLaw law,
                                       Frame frame,
                                       double spinDeltaT)

Protected constructor.

Parameters:

law - the orientation law from which the transformation with respect to a parent frame is computed.

frame - the parent frame.

spinDeltaT - the delta-T used to compute spin by finite differences

Method Detail

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,
                              boolean computeSpinDerivatives)
                       throws PatriusException

Get the Transform corresponding to specified date.

Spin derivative is never computed and is either 0 or null. No analytical formula is available for spin derivative. Spin is already computed by finite differences.

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,
                              FramesConfiguration config,
                              boolean computeSpinDerivatives)
                       throws PatriusException

Get the Transform corresponding to specified date.

Spin derivative is never computed and is either 0 or null. No analytical formula is available for spin derivative. Spin is already computed by finite differences.

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