fr.cnes.sirius.patrius.utils.legs

Interface LegsSequence<L extends Leg>

Type Parameters:

L - Implementation of a leg

All Superinterfaces:

Collection<L>, Iterable<L>, Leg, NavigableSet<L>, Serializable, Set<L>, SortedSet<L>

All Known Implementing Classes:

AbstractLegsSequence, AngularVelocitiesPolynomialProfile, AngularVelocitiesPolynomialSlew, AttitudeLegsSequence, AttitudeProfilesSequence, OrientationAngleLegsSequence, OrientationAngleProfileSequence

public interface LegsSequence<L extends Leg>
extends Leg, NavigableSet<L>

This interface represents a legs sequence and is also a leg.

Author:

morerem

Method Summary

Modifier and Type	Method and Description
void	clean() Clean the legs sequence by truncating every overlapping legs and removing included legs.
L	getLeg(AbsoluteDate date) Return the leg whose time interval contains the input date.
default String	toPrettyString() Returns a string representation of the legs sequence.

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

getNature, getTimeInterval, truncate

Methods inherited from interface java.util.NavigableSet

ceiling, descendingIterator, descendingSet, floor, headSet, headSet, higher, iterator, lower, pollFirst, pollLast, subSet, subSet, tailSet, tailSet

Methods inherited from interface java.util.SortedSet

comparator, first, last, spliterator

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

getLeg

L getLeg(AbsoluteDate date)
  throws PatriusException

Return the leg whose time interval contains the input date. On a transition between two legs, the next leg is returned.

Parameters:

date - input date

Returns:

leg

Throws:

PatriusException - thrown if no leg contains the input date

clean

void clean()
    throws PatriusException

Clean the legs sequence by truncating every overlapping legs and removing included legs.

This method should cover several cases for each legs couples (leg1/leg2) from the sequence :

• 1 - When the leg1 is included in the leg2 -> leg1 is removed
• 2 - When the leg2 is included in the leg1 -> leg2 is removed
• 3 - When the leg1 overlaps leg2 (so saying that leg2 overlaps leg1 is also true) : we check the two leg's upper dates.
  • The leg which is the more in the future is kept untouched.
  • The other one is truncated with its lower bound untouched and upper bound equals to the other leg's lower bound date with closed endpoint. It's possible for the two legs to overlaps only at this date if the other has a closed endpoint too.

Throws:

PatriusException - thrown if the new time interval is not included in the current time interval

toPrettyString

default String toPrettyString()

Returns a string representation of the legs sequence.

Specified by:

toPrettyString in interface Leg

Returns:

a string representation of the legs sequence.