fr.cnes.sirius.patrius.attitudes

Class AttitudeLegsSequence

java.lang.Object

fr.cnes.sirius.patrius.utils.legs.AbstractLegsSequence<AttitudeLeg>

fr.cnes.sirius.patrius.attitudes.AttitudeLegsSequence

All Implemented Interfaces:

AttitudeLeg, AttitudeProvider, Leg, LegsSequence<AttitudeLeg>, Serializable, Iterable<AttitudeLeg>, Collection<AttitudeLeg>, NavigableSet<AttitudeLeg>, Set<AttitudeLeg>, SortedSet<AttitudeLeg>

public final class AttitudeLegsSequence
extends AbstractLegsSequence<AttitudeLeg>
implements AttitudeLeg

This class handles a sequence of different attitude providers AttitudeLeg.

This class is different from the AttitudesSequence class in Orekit because even if they both represent a sequence of attitude laws, AttitudeLegsSequence contains attitude laws version "Attitude", while AttitudesSequence contains attitude laws version "Orbit determination"; moreover, AttitudeLegsSequence does not perform events detection between two consecutive attitude laws. This class implements AttitudeLeg, so it can be used as one.

Since:

1.1

Version:

$Id: AttitudeLegsSequence.java 17582 2017-05-10 12:58:16Z bignon $

Author:

cardosop

See Also:

Serialized Form

Concurrency :

not thread-safe

Concurrency comment :

The instances are mutable.

Constructor Summary

Constructors

Constructor and Description
AttitudeLegsSequence(String nature) Constructor.

Method Summary

Modifier and Type	Method and Description
Attitude	getAttitude(Orbit orbit) Compute the attitude corresponding to an orbital state.
Attitude	getAttitude(PVCoordinatesProvider pvProv, AbsoluteDate date, Frame frame) Gets the attitude from the sequence. The AttitudeLeg matching the date is called to compute the attitude.
Attitude	getPreviousAttitude(PVCoordinatesProvider provider, AbsoluteDate date, Frame frame) Returns attitude from previous leg (compared to leg matching provided date) from the sequence.
void	setSpinDerivativesComputation(boolean computeSpinDerivatives) Method to activate spin derivative computation.

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

add, addAll, ceiling, clear, comparator, contains, containsAll, descendingIterator, descendingSet, first, floor, getLeg, getNature, getTimeInterval, hasOverlaping, headSet, headSet, higher, isCompact, isEmpty, iterator, last, lower, pollFirst, pollLast, remove, removeAll, retainAll, size, subSet, subSet, tailSet, tailSet, 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.utils.legs.Leg

getNature, getTimeInterval

Methods inherited from interface java.util.SortedSet

spliterator

Methods inherited from interface java.util.Set

equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

AttitudeLegsSequence

public AttitudeLegsSequence(String nature)

Constructor.

Parameters:

nature - nature of the sequence

Method Detail

getAttitude

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

Gets the attitude from the sequence.
The AttitudeLeg 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.
The derivation order is : velocity.

Specified by:

getAttitude in interface AttitudeProvider

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 - if the date is out of the sequence's range.

getAttitude

public Attitude getAttitude(Orbit orbit)
                     throws PatriusException

Compute the attitude corresponding to an orbital state.

Specified by:

getAttitude in interface AttitudeProvider

Parameters:

orbit - current orbit

Returns:

attitude attitude on the current orbit

Throws:

PatriusException - if attitude cannot be computed

setSpinDerivativesComputation

public void setSpinDerivativesComputation(boolean computeSpinDerivatives)
                                   throws PatriusException

Method to activate spin derivative computation.

Specified by:

setSpinDerivativesComputation in interface AttitudeProvider

Parameters:

computeSpinDerivatives - true if spin derivatives should be computed

Throws:

PatriusException - if spin derivatives can not be computed

getPreviousAttitude

public Attitude getPreviousAttitude(PVCoordinatesProvider provider,
                                    AbsoluteDate date,
                                    Frame frame)
                             throws PatriusException

Returns attitude from previous leg (compared to leg matching provided date) from the sequence.

Warning: previous attitude leg has to be defined at provided date.

This method is mainly used for switching sequence in order to retrieve attitude before/after a switch. Thus provided date should be a switching date.

If two laws are juxtaposed at the given date, the SECOND law is the valid one.

Parameters:

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