fr.cnes.sirius.patrius.attitudes

Class SpinStabilized

java.lang.Object

fr.cnes.sirius.patrius.attitudes.AbstractAttitudeLaw

fr.cnes.sirius.patrius.attitudes.SpinStabilized

All Implemented Interfaces:

AttitudeLaw, AttitudeLawModifier, AttitudeProvider, Serializable

public class SpinStabilized
extends AbstractAttitudeLaw
implements AttitudeLawModifier

This class handles a spin stabilized attitude provider.

Spin stabilized laws are handled as wrappers for an underlying non-rotating law. This underlying law is typically an instance of CelestialBodyPointed with the pointing axis equal to the rotation axis, but can in fact be anything.

Instances of this class are guaranteed to be immutable.

Author:

Luc Maisonobe

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SpinStabilized(AttitudeLaw pNonRotatingLaw, AbsoluteDate pStart, Vector3D pAxis, double pRate) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
Attitude	getAttitude(PVCoordinatesProvider pvProv, AbsoluteDate date, Frame frame) Compute the attitude corresponding to an orbital state.
Vector3D	getAxis() Getter for the rotation axis in satellite frame.
AttitudeLaw	getNonRotatingLaw() Getter for the underlying non-rotating attitude law.
double	getRate() Getter for the spin rate in radians per seconds.
AbsoluteDate	getStartDate() Getter for the start date of the rotation.
AttitudeLaw	getUnderlyingAttitudeLaw() Get the underlying attitude law.
String	toString()

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, wait, wait, wait

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

computeSpinByFD, computeSpinDerivativeByFD, getAttitude, setSpinDerivativesComputation

Constructor Detail

SpinStabilized

public SpinStabilized(AttitudeLaw pNonRotatingLaw,
                      AbsoluteDate pStart,
                      Vector3D pAxis,
                      double pRate)

Creates a new instance.

Parameters:

pNonRotatingLaw - underlying non-rotating attitude law

pStart - start date of the rotation

pAxis - rotation axis in satellite frame

pRate - spin rate in radians per seconds

Method Detail

getAttitude

public final 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 for provided date

getUnderlyingAttitudeLaw

public final AttitudeLaw getUnderlyingAttitudeLaw()

Get the underlying attitude law.

Specified by:

getUnderlyingAttitudeLaw in interface AttitudeLawModifier

Returns:

underlying attitude law

getNonRotatingLaw

public AttitudeLaw getNonRotatingLaw()

Getter for the underlying non-rotating attitude law.

Returns:

the underlying non-rotating attitude law

getStartDate

public AbsoluteDate getStartDate()

Getter for the start date of the rotation.

Returns:

the start date of the rotation

getAxis

public Vector3D getAxis()

Getter for the rotation axis in satellite frame.

Returns:

the rotation axis in satellite frame

getRate

public double getRate()

Getter for the spin rate in radians per seconds.

Returns:

the spin rate in radians per seconds

toString

public String toString()

Overrides:

toString in class Object