fr.cnes.sirius.patrius.utils.legs

Interface LegsSequence<L extends Leg>

Type Parameters:

L - Any Leg class.

All Superinterfaces:

Collection<L>, Iterable<L>, TimeSequence<L>

All Known Implementing Classes:

AngularVelocitiesPolynomialProfile, AngularVelocitiesPolynomialSlew, AttitudeProfilesSequence, OrientationAngleLegsSequence, OrientationAngleProfileSequence, StrictAttitudeLegsSequence, StrictLegsSequence

public interface LegsSequence<L extends Leg>
extends TimeSequence<L>

A Collection of Leg objects.

Previously, this LegsSequence has been a NavigableSet, but too much methods were unsuitable for Legs objects.

Since:

4.7

Author:

Julien Anxionnat (CNES — DSO/DV/MP)

See Also:

Leg, TimeSequence, TimeStamped

Method Summary

Modifier and Type	Method and Description
L	current(TimeStamped t) Returns the current leg at the given date.
L	first() Returns the first element currently in this sequence.
L	first(TimeStamped t) Returns the first element after the given date.
AbsoluteDateInterval	getTimeInterval() Returns the time interval of the legs sequence.
LegsSequence<L>	head(L toLeg) Returns a new sequence from the beginning to the given element.
boolean	isEmpty(AbsoluteDate date, AbsoluteDate end) Checks whether the sequence is free on the given interval or not.
L	last() Returns the last element currently in this sequence.
L	last(TimeStamped t) Returns the last element before the given date.
L	next(L leg) Returns the strictly next element.
L	previous(L leg) Returns the strictly previous element.
Set<L>	simultaneous(L leg) Returns leg(s) at the same date.
LegsSequence<L>	sub(L fromLeg, L toLeg) Returns a new sequence extracted.
LegsSequence<L>	tail(L fromLeg) Returns a new sequence from the given element through the end.
default String	toPrettyString()

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

contains, containsAll, simultaneous

Methods inherited from interface java.util.Collection

add, addAll, clear, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

current

L current(TimeStamped t)

Returns the current leg at the given date.

Parameters:

t - A date from any TimeStamped object.

Returns:

The current Leg at the t date, or null if none.

first

L first()

Description copied from interface: TimeSequence

Returns the first element currently in this sequence.

Specified by:

first in interface TimeSequence<L extends Leg>

Returns:

The first Leg, null if none.

last

L last()

Description copied from interface: TimeSequence

Returns the last element currently in this sequence.

Specified by:

last in interface TimeSequence<L extends Leg>

Returns:

The last Leg, null if none.

first

L first(TimeStamped t)

Description copied from interface: TimeSequence

Returns the first element after the given date.

See TimeSequence.next(TimeStamped) for “strict” comparison.

Specified by:

first in interface TimeSequence<L extends Leg>

Parameters:

t - A date from any TimeStamped object.

Returns:

The first Leg starting after (or at) the given date t.

last

L last(TimeStamped t)

Description copied from interface: TimeSequence

Returns the last element before the given date.

See TimeSequence.previous(TimeStamped) for “strict” comparison.

Specified by:

last in interface TimeSequence<L extends Leg>

Parameters:

t - A date from any TimeStamped object.

Returns:

The last Leg finishing before (or at) the given date t.

simultaneous

Set<L> simultaneous(L leg)

Returns leg(s) at the same date.

Parameters:

leg - A Leg of this sequence.

Returns:

A Set of legs starting at the same date than the given leg. At least, that Set contains the given leg.

Throws:

IllegalArgumentException - If leg is not in the sequence.

previous

L previous(L leg)

Description copied from interface: TimeSequence

Returns the strictly previous element.

Specified by:

previous in interface TimeSequence<L extends Leg>

Parameters:

leg - Any element of this sequence.

Returns:

The previous Leg of the given leg, null if none.

next

L next(L leg)

Description copied from interface: TimeSequence

Returns the strictly next element.

Specified by:

next in interface TimeSequence<L extends Leg>

Parameters:

leg - Any element of this sequence.

Returns:

The next Leg of the given leg, null if none.

head

LegsSequence<L> head(L toLeg)

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

Specified by:

head in interface TimeSequence<L extends Leg>

Parameters:

toLeg - Any element of this sequence.

Returns:

A new Sequence object including all elements from the “beginning” to the given one (included).

tail

LegsSequence<L> tail(L fromLeg)

Returns a new sequence from the given element through the end.

Specified by:

tail in interface TimeSequence<L extends Leg>

Parameters:

fromLeg - Any element of this sequence.

Returns:

A new Sequence object including all elements from the given one (included) through the “end”.

sub

LegsSequence<L> sub(L fromLeg,
                    L toLeg)

Returns a new sequence extracted.

Specified by:

sub in interface TimeSequence<L extends Leg>

Parameters:

fromLeg - Any element of this sequence.

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

isEmpty

boolean isEmpty(AbsoluteDate date,
                AbsoluteDate end)

Checks whether the sequence is free on the given interval or not.

Parameters:

date - The “beginning” date.

end - The “end” date.

Returns:

true if this sequence is completely free during the given time interval.

toPrettyString

default String toPrettyString()

Specified by:

toPrettyString in interface TimeSequence<L extends Leg>

Returns:

A nice String representation.

getTimeInterval

AbsoluteDateInterval getTimeInterval()

Returns the time interval of the legs sequence.

Returns:

the time interval of the legs sequence.