fr.cnes.sirius.patrius.attitudes.profiles

Class AttitudeProfilesSequence

java.lang.Object

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

fr.cnes.sirius.patrius.attitudes.StrictAttitudeLegsSequence<AttitudeProfile>

fr.cnes.sirius.patrius.attitudes.profiles.AttitudeProfilesSequence

All Implemented Interfaces:

AttitudeProvider, LegsSequence<AttitudeProfile>, TimeSequence<AttitudeProfile>, Serializable, Iterable<AttitudeProfile>, Collection<AttitudeProfile>

public final class AttitudeProfilesSequence
extends StrictAttitudeLegsSequence<AttitudeProfile>

This class handles a sequence of AttitudeProfile.

Since:

4.2

Author:

delaygni

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AttitudeProfilesSequence()

Method Summary

Modifier and Type	Method and Description
AttitudeProfilesSequence	copy(AbsoluteDateInterval newInterval) Creates a new legs sequence from this one.
AttitudeProfilesSequence	copy(AbsoluteDateInterval newInterval, boolean strict) Creates a new legs sequence from this one.
Attitude	getAttitude(PVCoordinatesProvider pvProv, AbsoluteDate date, Frame frame) Gets the attitude from the sequence.
AbsoluteDateInterval	getTimeInterval() Returns the time interval of the legs sequence.
AttitudeProfilesSequence	head(AbsoluteDate toT) Returns a new sequence from the beginning to the given element.
AttitudeProfilesSequence	head(AbsoluteDate toT, boolean strict) Returns a new sequence from the beginning to the given element.
void	setSpinDerivativesComputation(boolean computeSpinDerivatives) Method to activate spin derivative computation.
AttitudeProfilesSequence	sub(AbsoluteDate fromT, AbsoluteDate toT) Returns a new sequence extracted.
AttitudeProfilesSequence	sub(AbsoluteDate fromT, AbsoluteDate toT, boolean strict) Returns a new sequence extracted.
AttitudeProfilesSequence	sub(AbsoluteDateInterval interval) Returns a new sequence extracted.
AttitudeProfilesSequence	sub(AbsoluteDateInterval interval, boolean strict) Returns a new sequence extracted.
AttitudeProfilesSequence	tail(AbsoluteDate fromT) Returns a new sequence from the given element to the end of the sequence.
AttitudeProfilesSequence	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.attitudes.StrictAttitudeLegsSequence

isSpinDerivativesComputation

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

computeSpinByFD, computeSpinDerivativeByFD, getAttitude

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

AttitudeProfilesSequence

public AttitudeProfilesSequence()

Method Detail

getAttitude

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

Gets the attitude from the sequence.
The AttitudeProfile matching the date is called to compute the attitude. If none is found, an PatriusException is thrown. If two laws are juxtaposed at the given date, the SECOND law is the valid one.

Specified by:

getAttitude in interface AttitudeProvider

Overrides:

getAttitude in class StrictAttitudeLegsSequence<AttitudeProfile>

Parameters:

pvProv - spacecraft's position and velocity coordinates provider

date - the date for which the attitude is computed

frame - the frame for which the attitude is computed

Returns:

the attitude

Throws:

PatriusException - thrown if the date is out of the sequence's range

setSpinDerivativesComputation

public void setSpinDerivativesComputation(boolean computeSpinDerivatives)

Method to activate spin derivative computation.

Specified by:

setSpinDerivativesComputation in interface AttitudeProvider

Overrides:

setSpinDerivativesComputation in class StrictAttitudeLegsSequence<AttitudeProfile>

Parameters:

computeSpinDerivatives - true if spin derivatives should be computed

toPrettyString

public String toPrettyString()

Specified by:

toPrettyString in interface LegsSequence<AttitudeProfile>

Specified by:

toPrettyString in interface TimeSequence<AttitudeProfile>

Overrides:

toPrettyString in class StrictLegsSequence<AttitudeProfile>

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 LegsSequence<AttitudeProfile>

Overrides:

getTimeInterval in class StrictLegsSequence<AttitudeProfile>

Returns:

the time interval of the legs sequence.

sub

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

Returns a new sequence extracted.

Specified by:

sub in interface LegsSequence<AttitudeProfile>

Overrides:

sub in class StrictAttitudeLegsSequence<AttitudeProfile>

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

Returns a new sequence extracted.

Specified by:

sub in interface LegsSequence<AttitudeProfile>

Overrides:

sub in class StrictAttitudeLegsSequence<AttitudeProfile>

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

Returns a new sequence extracted.

Specified by:

sub in interface LegsSequence<AttitudeProfile>

Overrides:

sub in class StrictAttitudeLegsSequence<AttitudeProfile>

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

Returns a new sequence extracted.

Specified by:

sub in interface LegsSequence<AttitudeProfile>

Overrides:

sub in class StrictAttitudeLegsSequence<AttitudeProfile>

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

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

Specified by:

head in interface LegsSequence<AttitudeProfile>

Overrides:

head in class StrictAttitudeLegsSequence<AttitudeProfile>

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

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

Specified by:

head in interface LegsSequence<AttitudeProfile>

Overrides:

head in class StrictAttitudeLegsSequence<AttitudeProfile>

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 AttitudeProfilesSequence 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<AttitudeProfile>

Overrides:

tail in class StrictAttitudeLegsSequence<AttitudeProfile>

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

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

Specified by:

tail in interface LegsSequence<AttitudeProfile>

Overrides:

tail in class StrictAttitudeLegsSequence<AttitudeProfile>

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

Creates a new legs sequence from this one.

Specified by:

copy in interface LegsSequence<AttitudeProfile>

Overrides:

copy in class StrictAttitudeLegsSequence<AttitudeProfile>

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 AttitudeProfilesSequence copy(AbsoluteDateInterval newInterval)

Creates a new legs sequence from this one.

Specified by:

copy in interface LegsSequence<AttitudeProfile>

Overrides:

copy in class StrictAttitudeLegsSequence<AttitudeProfile>

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.