fr.cnes.sirius.patrius.attitudes.profiles

Class AbstractAngularVelocitiesAttitudeProfile

java.lang.Object

fr.cnes.sirius.patrius.attitudes.profiles.AbstractAttitudeProfile

fr.cnes.sirius.patrius.attitudes.profiles.AbstractAngularVelocitiesAttitudeProfile

All Implemented Interfaces:

AttitudeLeg, AttitudeProvider, AttitudeProfile, Leg, Serializable

Direct Known Subclasses:

AngularVelocitiesHarmonicProfile, AngularVelocitiesPolynomialProfileLeg

public abstract class AbstractAngularVelocitiesAttitudeProfile
extends AbstractAttitudeProfile

An attitude profile which is defined by its angular velocity whose x-y-z components are represented with an underlying Vector3DFunction. The attitude orientation is computed integrating that angular velocity.

Since:

4.4

Author:

Pierre Brechard

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractAngularVelocitiesAttitudeProfile.AngularVelocityIntegrationType Attitude Angular Velocity Integration types.

Field Summary

Fields

Modifier and Type	Field and Description
protected AbsoluteDate	dateRef Reference date.
protected double	integStep Integration step.
protected Frame	refFrame Frame of initial rotation and Fourier series.
protected Rotation	rotationInitial Initial rotation.
protected boolean	spinDerivativesComputation Boolean for spin derivative computation.
protected Vector3DFunction	spinVectorFunction Angular velocity wrapper Vector3DFunction.
protected AbstractAngularVelocitiesAttitudeProfile.AngularVelocityIntegrationType	type Integration type.

Constructor Summary

Constructors

Constructor and Description
AbstractAngularVelocitiesAttitudeProfile(Vector3DFunction spinVectorFunction, Frame frame, AbsoluteDateInterval interval, Rotation rotationRef, AbsoluteDate dateRef, AbstractAngularVelocitiesAttitudeProfile.AngularVelocityIntegrationType integType, double integStep, int cacheFreq, String nature) Constructor.
AbstractAngularVelocitiesAttitudeProfile(Vector3DFunction spinVectorFunction, Frame frame, AbsoluteDateInterval interval, Rotation rotationRef, AbsoluteDate dateRef, AbstractAngularVelocitiesAttitudeProfile.AngularVelocityIntegrationType integType, double integStep, String nature) Constructor.

Method Summary

Modifier and Type	Method and Description
void	clearCache() Removes all of the elements from the orientation rotation cache
Attitude	getAttitude(PVCoordinatesProvider pvProv, AbsoluteDate date, Frame frame) Compute the attitude corresponding to an orbital state.
protected Rotation	getOrientation(AbsoluteDate date) Gets the orientation from the angular velocity function at a given date, integrating the function.
void	setSpinDerivativesComputation(boolean computeSpinDerivatives) Method to activate spin derivative computation.

Methods inherited from class fr.cnes.sirius.patrius.attitudes.profiles.AbstractAttitudeProfile

checkDate, getAttitude, getNature, getTimeInterval, truncate

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.utils.legs.Leg

toPrettyString

Field Detail

spinVectorFunction

protected Vector3DFunction spinVectorFunction

Angular velocity wrapper Vector3DFunction.

refFrame

protected final Frame refFrame

Frame of initial rotation and Fourier series.

rotationInitial

protected Rotation rotationInitial

Initial rotation.

dateRef

protected AbsoluteDate dateRef

Reference date.

type

protected final AbstractAngularVelocitiesAttitudeProfile.AngularVelocityIntegrationType type

Integration type.

integStep

protected final double integStep

Integration step.

spinDerivativesComputation

protected boolean spinDerivativesComputation

Boolean for spin derivative computation.

Constructor Detail

AbstractAngularVelocitiesAttitudeProfile

public AbstractAngularVelocitiesAttitudeProfile(Vector3DFunction spinVectorFunction,
                                                Frame frame,
                                                AbsoluteDateInterval interval,
                                                Rotation rotationRef,
                                                AbsoluteDate dateRef,
                                                AbstractAngularVelocitiesAttitudeProfile.AngularVelocityIntegrationType integType,
                                                double integStep,
                                                int cacheFreq,
                                                String nature)
                                         throws PatriusException

Constructor.

Parameters:

spinVectorFunction - Angular velocity wrapper Vector3DFunction

frame - frame where initial rotation and the x,y,z components are expressed

interval - interval of profile

rotationRef - rotation at reference date

dateRef - Reference date

integType - integration type (see AbstractAngularVelocitiesAttitudeProfile.AngularVelocityIntegrationType)

integStep - integration step

cacheFreq - Number of integration steps performed between two values stored in the underlying cache

nature - Nature

Throws:

PatriusException - thrown if the reference date is after the lower bound of the interval to be covered by the profile

AbstractAngularVelocitiesAttitudeProfile

public AbstractAngularVelocitiesAttitudeProfile(Vector3DFunction spinVectorFunction,
                                                Frame frame,
                                                AbsoluteDateInterval interval,
                                                Rotation rotationRef,
                                                AbsoluteDate dateRef,
                                                AbstractAngularVelocitiesAttitudeProfile.AngularVelocityIntegrationType integType,
                                                double integStep,
                                                String nature)
                                         throws PatriusException

Constructor.

Parameters:

spinVectorFunction - Angular velocity wrapper Vector3DFunction

frame - frame where initial rotation and the x,y,z components are expressed

interval - interval of profile

rotationRef - rotation at reference date

dateRef - Reference date

integType - integration type (see AbstractAngularVelocitiesAttitudeProfile.AngularVelocityIntegrationType)

integStep - integration step

nature - Nature

Throws:

PatriusException - thrown if the reference date is after the lower bound of the interval to be covered by the profile

Method Detail

getAttitude

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

Compute the attitude corresponding to an orbital state.

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

setSpinDerivativesComputation

public void setSpinDerivativesComputation(boolean computeSpinDerivatives)
                                   throws PatriusException

Method to activate spin derivative computation.

Parameters:

computeSpinDerivatives - true if spin derivatives should be computed

Throws:

PatriusException - if spin derivatives can not be computed

getOrientation

protected Rotation getOrientation(AbsoluteDate date)
                           throws PatriusException

Gets the orientation from the angular velocity function at a given date, integrating the function.

Parameters:

date - the date

Returns:

the orientation at a given date

Throws:

PatriusException - thrown if the date is outside the covered interval

clearCache

public void clearCache()

Removes all of the elements from the orientation rotation cache