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:

AttitudeLeg, AttitudeProvider, AttitudeProfile, TimeStamped, Leg, LegsSequence<AttitudeProfile>, TimeSequence<AttitudeProfile>, Serializable, Iterable<AttitudeProfile>, Collection<AttitudeProfile>

public final class AttitudeProfilesSequence
extends StrictAttitudeLegsSequence<AttitudeProfile>
implements AttitudeProfile

This class handles a sequence of AttitudeProfile.

Since:

4.2

Author:

delaygni

See Also:

Serialized Form

Field Summary

Fields inherited from interface fr.cnes.sirius.patrius.attitudes.AttitudeLeg

LEG_NATURE

Constructor Summary

Constructors

Constructor and Description
AttitudeProfilesSequence() Constructor with default nature.
AttitudeProfilesSequence(String nature) Constructor.

Method Summary

Modifier and Type	Method and Description
AttitudeProfilesSequence	copy(AbsoluteDateInterval newInterval) Creates a new leg from this one.
Attitude	getAttitude(PVCoordinatesProvider pvProv, AbsoluteDate date, Frame frame) Gets the attitude from the sequence.
String	getNature() Returns the nature of the leg.
AbsoluteDateInterval	getTimeInterval() Returns the time interval of the legs sequence.
void	setSpinDerivativesComputation(boolean computeSpinDerivatives) Method to activate spin derivative computation.
String	toPrettyString() Returns a nice String representation.

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

computeSpinByFD, computeSpinDerivativeByFD

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

getDate, getEnd

Methods inherited from interface fr.cnes.sirius.patrius.attitudes.AttitudeProvider

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(String nature)

Constructor.

Parameters:

nature - nature of the sequence

AttitudeProfilesSequence

public AttitudeProfilesSequence()

Constructor with default nature.

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

getNature

public String getNature()

Returns the nature of the leg.

Specified by:

getNature in interface Leg

Returns:

The “nature” of the leg.

copy

public AttitudeProfilesSequence copy(AbsoluteDateInterval newInterval)

Creates a new leg from this one.

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

Specified by:

toPrettyString in interface TimeSequence<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 Leg

Specified by:

getTimeInterval in interface LegsSequence<AttitudeProfile>

Overrides:

getTimeInterval in class StrictLegsSequence<AttitudeProfile>

Returns:

the time interval of the legs sequence.