fr.cnes.sirius.patrius.attitudes.orientations

Class OrientationAngleLegsSequence

java.lang.Object

fr.cnes.sirius.patrius.utils.legs.StrictLegsSequence<OrientationAngleLeg>

fr.cnes.sirius.patrius.attitudes.orientations.OrientationAngleLegsSequence

All Implemented Interfaces:

OrientationAngleLeg, OrientationAngleProvider, TimeStamped, Leg, LegsSequence<OrientationAngleLeg>, TimeSequence<OrientationAngleLeg>, Serializable, Iterable<OrientationAngleLeg>, Collection<OrientationAngleLeg>

public class OrientationAngleLegsSequence
extends StrictLegsSequence<OrientationAngleLeg>
implements OrientationAngleLeg

This class handles a sequence of one or several OrientationAngleLeg. This sequence can be handled as an StrictLegsSequence of OrientationAngleLeg.

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
OrientationAngleLegsSequence() Constructor with default value for the legs sequence nature.
OrientationAngleLegsSequence(String nature) Constructor.

Method Summary

Modifier and Type	Method and Description
OrientationAngleLegsSequence	copy(AbsoluteDateInterval newInterval) Creates a new leg from this one.
String	getNature() Returns the nature of the leg.
Double	getOrientationAngle(PVCoordinatesProvider pvProv, AbsoluteDate date) Compute the orientation angle corresponding to an orbital state.
AbsoluteDateInterval	getTimeInterval() Returns the time interval of the legs sequence.
String	toPrettyString() Returns a nice String representation.

Methods inherited from class fr.cnes.sirius.patrius.utils.legs.StrictLegsSequence

add, addAll, clear, current, first, first, head, isEmpty, isEmpty, iterator, last, last, next, previous, remove, removeAll, retainAll, simultaneous, simultaneous, size, sub, tail, toArray, toArray

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

computeSpinByFD, computeSpinDerivativeByFD

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

computeSpinNumerical

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

getDate, getEnd

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

contains, containsAll

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

OrientationAngleLegsSequence

public OrientationAngleLegsSequence(String nature)

Constructor.

Parameters:

nature - nature of the sequence

OrientationAngleLegsSequence

public OrientationAngleLegsSequence()

Constructor with default value for the legs sequence nature.

Method Detail

getOrientationAngle

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

Compute the orientation angle corresponding to an orbital state.

Specified by:

getOrientationAngle in interface OrientationAngleProvider

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

getNature

public String getNature()

Returns the nature of the leg.

Specified by:

getNature in interface Leg

Returns:

The “nature” of the leg.

copy

public OrientationAngleLegsSequence copy(AbsoluteDateInterval newInterval)

Creates a new leg from this one. Sequence is supposed to be continuous.

Specified by:

copy in interface Leg

Parameters:

newInterval - The time interval of the leg to create

Returns:

A new Leg valid on provided interval

toPrettyString

public String toPrettyString()

Returns a nice String representation.

Specified by:

toPrettyString in interface Leg

Specified by:

toPrettyString in interface LegsSequence<OrientationAngleLeg>

Specified by:

toPrettyString in interface TimeSequence<OrientationAngleLeg>

Returns:

A nice String representation.

getTimeInterval

public AbsoluteDateInterval getTimeInterval()

Returns the time interval of the legs sequence.

Null is returned if the sequence is empty.

Warning: in case of sequences with holes, the sequence in the returned interval will not contain continuous data.

Sequence is supposed to be continuous.

Specified by:

getTimeInterval in interface Leg

Specified by:

getTimeInterval in interface LegsSequence<OrientationAngleLeg>

Overrides:

getTimeInterval in class StrictLegsSequence<OrientationAngleLeg>

Returns:

the time interval of the legs sequence.