fr.cnes.sirius.patrius.attitudes

Class ComposedAttitudeLaw

java.lang.Object

fr.cnes.sirius.patrius.attitudes.AbstractAttitudeLaw

fr.cnes.sirius.patrius.attitudes.ComposedAttitudeLaw

All Implemented Interfaces:

AttitudeLaw, AttitudeLawModifier, AttitudeProvider, Serializable

public class ComposedAttitudeLaw
extends AbstractAttitudeLaw
implements AttitudeLawModifier

This class represents a composed attitude law, defined by a main attitude law provider and a chained list of orientation laws.
The main attitude law provides, for a given date, the dynamic frame representing the spacecraft orientation; this orientation is then progressively transformed using the orientation laws.

Since:

1.1

Version:

$Id: ComposedAttitudeLaw.java 17582 2017-05-10 12:58:16Z bignon $

Author:

Julie Anton

See Also:

AttitudeFrame, AttitudeTransformProvider, Serialized Form

Concurrency :

conditionally thread-safe

Concurrency comment :

is thread-safe if the AttitudeLaw attribute is.

Constructor Summary

Constructors

Constructor and Description
ComposedAttitudeLaw(AttitudeLaw law, LinkedList<IOrientationLaw> modifiers) Builds a composed attitude law from a man attitude law provider and a list of modifier orientation laws.
ComposedAttitudeLaw(AttitudeLaw law, LinkedList<IOrientationLaw> modifiers, double spinDeltaT) Builds a composed attitude law from a man attitude law provider and a list of modifier orientation laws.

Method Summary

Modifier and Type	Method and Description
Attitude	getAttitude(PVCoordinatesProvider pvProv, AbsoluteDate date, Frame frame) Compute the attitude corresponding to an orbital state.
AttitudeLaw	getUnderlyingAttitudeLaw() Get the underlying attitude law.

Methods inherited from class fr.cnes.sirius.patrius.attitudes.AbstractAttitudeLaw

getSpinDerivativesComputation, setSpinDerivativesComputation

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.cnes.sirius.patrius.attitudes.AttitudeProvider

computeSpinByFD, computeSpinDerivativeByFD, getAttitude, setSpinDerivativesComputation

Constructor Detail

ComposedAttitudeLaw

public ComposedAttitudeLaw(AttitudeLaw law,
                           LinkedList<IOrientationLaw> modifiers)

Builds a composed attitude law from a man attitude law provider and a list of modifier orientation laws.

Parameters:

law - the main attitude law

modifiers - the orientation laws

ComposedAttitudeLaw

public ComposedAttitudeLaw(AttitudeLaw law,
                           LinkedList<IOrientationLaw> modifiers,
                           double spinDeltaT)

Builds a composed attitude law from a man attitude law provider and a list of modifier orientation laws.

Parameters:

law - the main attitude law

modifiers - the orientation laws

spinDeltaT - delta-t used for spin computation by finite differences

Method Detail

getUnderlyingAttitudeLaw

public AttitudeLaw getUnderlyingAttitudeLaw()

Get the underlying attitude law.

Specified by:

getUnderlyingAttitudeLaw in interface AttitudeLawModifier

Returns:

underlying attitude law

getAttitude

public Attitude getAttitude(PVCoordinatesProvider pvProv,
                            AbsoluteDate date,
                            Frame frame)
                     throws PatriusException

Compute the attitude corresponding to an orbital state.

Specified by:

getAttitude in interface AttitudeProvider

Parameters:

pvProv - local position-velocity provider around current date

date - current date

frame - reference frame from which attitude is computed

Returns:

attitude on the specified date and position-velocity state

Throws:

PatriusException - if attitude cannot be computed for provided date