fr.cnes.sirius.patrius.attitudes.orientations

Class OrientationAngleProfileSequence

java.lang.Object

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

fr.cnes.sirius.patrius.attitudes.orientations.OrientationAngleProfileSequence

All Implemented Interfaces:

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

public class OrientationAngleProfileSequence
extends StrictLegsSequence<OrientationAngleProfile>
implements OrientationAngleProfile

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

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

Method Summary

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

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

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

OrientationAngleProfileSequence

public OrientationAngleProfileSequence(String nature)

Constructor.

Parameters:

nature - nature of the sequence

OrientationAngleProfileSequence

public OrientationAngleProfileSequence()

Constructor with default value for the profiles 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 OrientationAngleProfileSequence copy(AbsoluteDateInterval newInterval)

Creates a new legs sequence from this one.

Specified by:

copy in interface OrientationAngleLeg

Specified by:

copy in interface OrientationAngleProfile

Specified by:

copy in interface Leg

Specified by:

copy in interface LegsSequence<OrientationAngleProfile>

Overrides:

copy in class StrictLegsSequence<OrientationAngleProfile>

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.

toPrettyString

public String toPrettyString()

Returns a nice String representation.

Specified by:

toPrettyString in interface Leg

Specified by:

toPrettyString in interface LegsSequence<OrientationAngleProfile>

Specified by:

toPrettyString in interface TimeSequence<OrientationAngleProfile>

Overrides:

toPrettyString in class StrictLegsSequence<OrientationAngleProfile>

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<OrientationAngleProfile>

Overrides:

getTimeInterval in class StrictLegsSequence<OrientationAngleProfile>

Returns:

the time interval of the legs sequence.

sub

public OrientationAngleProfileSequence sub(AbsoluteDate fromT,
                                           AbsoluteDate toT,
                                           boolean strict)

Returns a new sequence extracted.

Specified by:

sub in interface LegsSequence<OrientationAngleProfile>

Overrides:

sub in class StrictLegsSequence<OrientationAngleProfile>

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 OrientationAngleProfileSequence sub(AbsoluteDate fromT,
                                           AbsoluteDate toT)

Returns a new sequence extracted.

Specified by:

sub in interface LegsSequence<OrientationAngleProfile>

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 OrientationAngleProfileSequence sub(AbsoluteDateInterval interval,
                                           boolean strict)

Returns a new sequence extracted.

Specified by:

sub in interface LegsSequence<OrientationAngleProfile>

Overrides:

sub in class StrictLegsSequence<OrientationAngleProfile>

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 OrientationAngleProfileSequence sub(AbsoluteDateInterval interval)

Returns a new sequence extracted.

Specified by:

sub in interface LegsSequence<OrientationAngleProfile>

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 OrientationAngleProfileSequence head(AbsoluteDate toT,
                                            boolean strict)

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

Specified by:

head in interface LegsSequence<OrientationAngleProfile>

Overrides:

head in class StrictLegsSequence<OrientationAngleProfile>

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 OrientationAngleProfileSequence head(AbsoluteDate toT)

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

Specified by:

head in interface LegsSequence<OrientationAngleProfile>

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 OrientationAngleProfileSequence 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<OrientationAngleProfile>

Overrides:

tail in class StrictLegsSequence<OrientationAngleProfile>

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 OrientationAngleProfileSequence tail(AbsoluteDate fromT)

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

Specified by:

tail in interface LegsSequence<OrientationAngleProfile>

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 OrientationAngleProfileSequence copy(AbsoluteDateInterval newInterval,
                                            boolean strict)

Creates a new legs sequence from this one.

Specified by:

copy in interface LegsSequence<OrientationAngleProfile>

Overrides:

copy in class StrictLegsSequence<OrientationAngleProfile>

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