fr.cnes.sirius.patrius.attitudes.orientations

Class OrientationAngleLawLeg

java.lang.Object

fr.cnes.sirius.patrius.attitudes.orientations.AbstractOrientationAngleLeg

fr.cnes.sirius.patrius.attitudes.orientations.OrientationAngleLawLeg

All Implemented Interfaces:

OrientationAngleLeg, OrientationAngleProvider, TimeStamped, Leg, Serializable

public class OrientationAngleLawLeg
extends AbstractOrientationAngleLeg

This class represents an OrientationAngleLaw on which an interval of validity is defined (whose borders are closed points).

Since:

4.2

Author:

delaygni

See Also:

Serialized Form

Field Summary

Fields inherited from interface fr.cnes.sirius.patrius.utils.legs.Leg

LEG_NATURE

Constructor Summary

Constructors

Constructor and Description
OrientationAngleLawLeg(OrientationAngleLaw orientationAngleLawIn, AbsoluteDate initialDate, AbsoluteDate finalDate) Constructor
OrientationAngleLawLeg(OrientationAngleLaw orientationAngleLawIn, AbsoluteDate initialDate, AbsoluteDate finalDate, String natureIn) Constructor
OrientationAngleLawLeg(OrientationAngleLaw orientationAngleLawIn, AbsoluteDate initialDate, AbsoluteDate finalDate, String natureIn, boolean timeTolerant) Constructor

Method Summary

Modifier and Type	Method and Description
OrientationAngleLawLeg	copy(AbsoluteDateInterval newInterval) Creates a new leg from this one.
Double	getOrientationAngle(PVCoordinatesProvider pvProv, AbsoluteDate date) Compute the orientation angle corresponding to an orbital state.

Methods inherited from class fr.cnes.sirius.patrius.attitudes.orientations.AbstractOrientationAngleLeg

getNature, getTimeInterval

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.orientations.OrientationAngleLeg

build, computeSpinByFD, computeSpinDerivativeByFD

Methods inherited from interface fr.cnes.sirius.patrius.attitudes.orientations.OrientationAngleProvider

build, computeSpinNumerical

Methods inherited from interface fr.cnes.sirius.patrius.utils.legs.Leg

contains, getDate, getEnd, toPrettyString

Constructor Detail

OrientationAngleLawLeg

public OrientationAngleLawLeg(OrientationAngleLaw orientationAngleLawIn,
                              AbsoluteDate initialDate,
                              AbsoluteDate finalDate)

Constructor

Parameters:

orientationAngleLawIn - provider of the AttitudeLaw

initialDate - start date of the interval of validity

finalDate - end date of the interval of validity

OrientationAngleLawLeg

public OrientationAngleLawLeg(OrientationAngleLaw orientationAngleLawIn,
                              AbsoluteDate initialDate,
                              AbsoluteDate finalDate,
                              String natureIn)

Constructor

Parameters:

orientationAngleLawIn - provider of the AttitudeLaw

initialDate - start date of the interval of validity

finalDate - end date of the interval of validity

natureIn - leg nature

OrientationAngleLawLeg

public OrientationAngleLawLeg(OrientationAngleLaw orientationAngleLawIn,
                              AbsoluteDate initialDate,
                              AbsoluteDate finalDate,
                              String natureIn,
                              boolean timeTolerant)

Constructor

Parameters:

orientationAngleLawIn - provider of the AttitudeLaw

initialDate - start date of the interval of validity

finalDate - end date of the interval of validity

natureIn - leg nature

timeTolerant - true if leg can be used outside its validity interval, false otherwise

Method Detail

getOrientationAngle

public Double getOrientationAngle(PVCoordinatesProvider pvProv,
                                  AbsoluteDate date)
                           throws PatriusException

Compute the orientation angle corresponding to an orbital state.

Parameters:

pvProv - position-velocity provider around current date

date - date

Returns:

orientation angle at the specified date and position-velocity state, null if outside interval

Throws:

PatriusException - thrown if the angle cannot be computed

copy

public OrientationAngleLawLeg copy(AbsoluteDateInterval newInterval)

Creates a new leg from this one.

Provided interval does not have to be included in current time interval.

Parameters:

newInterval - The time interval of the leg to create

Returns:

A new Leg valid on provided interval