fr.cnes.sirius.patrius.attitudes

Class AttitudeLawLeg

java.lang.Object

fr.cnes.sirius.patrius.attitudes.AttitudeLawLeg

All Implemented Interfaces:

AttitudeLeg, AttitudeProvider, Leg, Serializable

public final class AttitudeLawLeg
extends Object
implements AttitudeLeg

This class represents an attitude law version "attitude", with an interval of validity (whose borders are closed points).

Since:

1.1

Version:

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

Author:

Julie Anton

See Also:

Serialized Form

Concurrency :

conditionally thread-safe

Concurrency comment :

The use of an AttitudeLaw makes it thread-safe only if the AttitudeLaw is.

Constructor Summary

Constructors

Constructor and Description
AttitudeLawLeg(AttitudeLaw attitudeLaw, AbsoluteDate initialDate, AbsoluteDate finalDate) Build an attitude law version "attitude".
AttitudeLawLeg(AttitudeLaw attitudeLaw, AbsoluteDate initialDate, AbsoluteDate finalDate, String natureIn) Build an attitude law version "attitude".

Method Summary

Modifier and Type	Method and Description
Attitude	getAttitude(Orbit orbit) Compute the attitude corresponding to an orbital state.
Attitude	getAttitude(PVCoordinatesProvider pvProv, AbsoluteDate date, Frame frame) Compute the attitude corresponding to an orbital state.
AttitudeLaw	getAttitudeLaw() Gets the attitude law provider associated to the current attitude leg.
String	getNature() Return the nature of the leg.
AbsoluteDateInterval	getTimeInterval() Return the time interval of validity of the leg
void	setSpinDerivativesComputation(boolean computeSpinDerivatives) Method to activate spin derivative computation.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttitudeLawLeg

public AttitudeLawLeg(AttitudeLaw attitudeLaw,
                      AbsoluteDate initialDate,
                      AbsoluteDate finalDate)

Build an attitude law version "attitude". Its interval of validity has closed endpoints.

Parameters:

attitudeLaw - : provider of the attitude law

initialDate - : start date of the interval of validity

finalDate - : end date of the interval of validity

AttitudeLawLeg

public AttitudeLawLeg(AttitudeLaw attitudeLaw,
                      AbsoluteDate initialDate,
                      AbsoluteDate finalDate,
                      String natureIn)

Build an attitude law version "attitude". Its interval of validity has closed endpoints.

Parameters:

attitudeLaw - : provider of the attitude law

initialDate - : start date of the interval of validity

finalDate - : end date of the interval of validity

natureIn - leg nature

Method Detail

getTimeInterval

public AbsoluteDateInterval getTimeInterval()

Return the time interval of validity of the leg

Specified by:

getTimeInterval in interface Leg

Returns:

time interval of validity of the leg

getAttitudeLaw

public AttitudeLaw getAttitudeLaw()

Gets the attitude law provider associated to the current attitude leg.

Returns:

the AttitudeLaw of the current leg

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 attitude on the specified date and position-velocity state

Throws:

PatriusException - if attitude cannot be computed

getAttitude

public Attitude getAttitude(Orbit orbit)
                     throws PatriusException

Compute the attitude corresponding to an orbital state.

Specified by:

getAttitude in interface AttitudeProvider

Parameters:

orbit - current orbit

Returns:

attitude attitude on the current orbit

Throws:

PatriusException - if attitude cannot be computed

setSpinDerivativesComputation

public void setSpinDerivativesComputation(boolean computeSpinDerivatives)
                                   throws PatriusException

Method to activate spin derivative computation.

Spin derivatives computation applies to underlying law.

Specified by:

setSpinDerivativesComputation in interface AttitudeProvider

Parameters:

computeSpinDerivatives - true if spin derivatives should be computed

Throws:

PatriusException - if spin derivatives can not be computed

getNature

public String getNature()

Return the nature of the leg.

Specified by:

getNature in interface Leg

Returns:

nature of the leg