fr.cnes.sirius.patrius.attitudes.orientations

Class OrientationAngleLegsSequence<L extends OrientationAngleLeg>

java.lang.Object

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

fr.cnes.sirius.patrius.attitudes.orientations.OrientationAngleLegsSequence<L>

Type Parameters:

L - OrientationAngleLeg

All Implemented Interfaces:

OrientationAngleProvider, LegsSequence<L>, TimeSequence<L>, Serializable, Iterable<L>, Collection<L>

public class OrientationAngleLegsSequence<L extends OrientationAngleLeg>
extends StrictLegsSequence<L>
implements OrientationAngleProvider

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

Modifier and Type	Field and Description
static String	DEFAULT_ORIENTATION_SEQUENCE_NATURE Default nature.

Constructor Summary

Constructors

Constructor and Description
OrientationAngleLegsSequence() Simple constructor with default name defining the legs sequence nature.
OrientationAngleLegsSequence(String nature) Constructor.

Method Summary

Modifier and Type	Method and Description
OrientationAngleLegsSequence<L>	copy(AbsoluteDateInterval newInterval) Creates a new legs sequence from this one.
OrientationAngleLegsSequence<L>	copy(AbsoluteDateInterval newInterval, boolean strict) Creates a new legs sequence from this one.
String	getNature() Get the legs sequence nature.
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.
OrientationAngleLegsSequence<L>	head(AbsoluteDate toT) Returns a new sequence from the beginning to the given element.
OrientationAngleLegsSequence<L>	head(AbsoluteDate toT, boolean strict) Returns a new sequence from the beginning to the given element.
OrientationAngleLegsSequence<L>	sub(AbsoluteDate fromT, AbsoluteDate toT) Returns a new sequence extracted.
OrientationAngleLegsSequence<L>	sub(AbsoluteDate fromT, AbsoluteDate toT, boolean strict) Returns a new sequence extracted.
OrientationAngleLegsSequence<L>	sub(AbsoluteDateInterval interval) Returns a new sequence extracted.
OrientationAngleLegsSequence<L>	sub(AbsoluteDateInterval interval, boolean strict) Returns a new sequence extracted.
OrientationAngleLegsSequence<L>	tail(AbsoluteDate fromT) Returns a new sequence from the given element to the end of the sequence.
OrientationAngleLegsSequence<L>	tail(AbsoluteDate fromT, boolean strict) Returns a new sequence from the given element to the end of the sequence.
String	toPrettyString()

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

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

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

build, computeSpinByFD, computeSpinDerivativeByFD, computeSpinNumerical

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

Field Detail

DEFAULT_ORIENTATION_SEQUENCE_NATURE

public static final String DEFAULT_ORIENTATION_SEQUENCE_NATURE

Default nature.

See Also:

Constant Field Values

Constructor Detail

OrientationAngleLegsSequence

public OrientationAngleLegsSequence()

Simple constructor with default name defining the legs sequence nature.

OrientationAngleLegsSequence

public OrientationAngleLegsSequence(String nature)

Constructor.

Parameters:

nature - nature of the sequence

Method Detail

getNature

public String getNature()

Get the legs sequence nature.

Returns:

the nature

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 input date is not contained in any leg's time interval of the sequence

Throws:

PatriusException - thrown if the angle cannot be computed

toPrettyString

public String toPrettyString()

Specified by:

toPrettyString in interface LegsSequence<L extends OrientationAngleLeg>

Specified by:

toPrettyString in interface TimeSequence<L extends OrientationAngleLeg>

Overrides:

toPrettyString in class StrictLegsSequence<L extends 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 over time.

Specified by:

getTimeInterval in interface LegsSequence<L extends OrientationAngleLeg>

Overrides:

getTimeInterval in class StrictLegsSequence<L extends OrientationAngleLeg>

Returns:

the time interval of the legs sequence.

sub

public OrientationAngleLegsSequence<L> sub(AbsoluteDate fromT,
                                           AbsoluteDate toT,
                                           boolean strict)

Returns a new sequence extracted.

Specified by:

sub in interface LegsSequence<L extends OrientationAngleLeg>

Overrides:

sub in class StrictLegsSequence<L extends OrientationAngleLeg>

Parameters:

fromT - Any element of this sequence.

toT - Any element of this sequence.

strict - true if boundaries shall not be included in the extracted sequence, false otherwise.

Returns:

A new Sequence object including all elements from the given one fromT to the given one. Elements exactly on the interval boundaries are included only if strict = false.

sub

public OrientationAngleLegsSequence<L> sub(AbsoluteDate fromT,
                                           AbsoluteDate toT)

Returns a new sequence extracted.

Specified by:

sub in interface LegsSequence<L extends OrientationAngleLeg>

Parameters:

fromT - Any element of this sequence.

toT - Any element of this sequence.

Returns:

A new Sequence object including all elements from the given one fromT to the given one toT (both included).

sub

public OrientationAngleLegsSequence<L> sub(AbsoluteDateInterval interval,
                                           boolean strict)

Returns a new sequence extracted.

Specified by:

sub in interface LegsSequence<L extends OrientationAngleLeg>

Overrides:

sub in class StrictLegsSequence<L extends OrientationAngleLeg>

Parameters:

interval - interval.

strict - true if boundaries shall not be included in the extracted sequence, false otherwise.

Returns:

A new Sequence object including all elements included in the interval . Elements exactly on the interval boundaries are included only if strict = false.

sub

public OrientationAngleLegsSequence<L> sub(AbsoluteDateInterval interval)

Returns a new sequence extracted.

Specified by:

sub in interface LegsSequence<L extends OrientationAngleLeg>

Parameters:

interval - interval.

Returns:

A new Sequence object including all elements included in the interval . Elements exactly on the interval boundaries are included.

head

public OrientationAngleLegsSequence<L> head(AbsoluteDate toT,
                                            boolean strict)

Returns a new sequence from the beginning to the given element.

Specified by:

head in interface LegsSequence<L extends OrientationAngleLeg>

Overrides:

head in class StrictLegsSequence<L extends OrientationAngleLeg>

Parameters:

toT - Any element of this sequence.

strict - true if boundary shall not be included in the extracted sequence, false otherwise.

Returns:

A new Sequence object including all elements from the “beginning” to the given one (included only if strict = false).

head

public OrientationAngleLegsSequence<L> head(AbsoluteDate toT)

Returns a new sequence from the beginning to the given element.

Specified by:

head in interface LegsSequence<L extends OrientationAngleLeg>

Parameters:

toT - Any element of this sequence.

Returns:

A new Sequence object including all elements from the “beginning” to the given one (included).

tail

public OrientationAngleLegsSequence<L> tail(AbsoluteDate fromT,
                                            boolean strict)

Returns a new sequence from the given element to the end of the sequence.

Specified by:

tail in interface LegsSequence<L extends OrientationAngleLeg>

Overrides:

tail in class StrictLegsSequence<L extends OrientationAngleLeg>

Parameters:

fromT - Any element of this sequence.

strict - true if boundary shall not be included in the extracted sequence, false otherwise.

Returns:

A new Sequence object including all elements from the given one (included only if strict = false) to the “end” of the sequence.

tail

public OrientationAngleLegsSequence<L> tail(AbsoluteDate fromT)

Returns a new sequence from the given element to the end of the sequence.

Specified by:

tail in interface LegsSequence<L extends OrientationAngleLeg>

Parameters:

fromT - Any element of this sequence.

Returns:

A new Sequence object including all elements from the given one (included) to the “end” of the sequence.

copy

public OrientationAngleLegsSequence<L> copy(AbsoluteDateInterval newInterval,
                                            boolean strict)

Creates a new legs sequence from this one.

Specified by:

copy in interface LegsSequence<L extends OrientationAngleLeg>

Overrides:

copy in class StrictLegsSequence<L extends OrientationAngleLeg>

Parameters:

newInterval - The time interval of the legs sequence to create

strict - true if boundaries shall not be included in the new sequence, false otherwise.

Returns:

A new LegsSequence valid on provided interval

copy

public OrientationAngleLegsSequence<L> copy(AbsoluteDateInterval newInterval)

Creates a new legs sequence from this one.

Specified by:

copy in interface LegsSequence<L extends OrientationAngleLeg>

Overrides:

copy in class StrictLegsSequence<L extends OrientationAngleLeg>

Parameters:

newInterval - The time interval of the legs sequence to create

Returns:

A new LegsSequence valid on provided interval. Boundaries are not included in the new sequence.