fr.cnes.sirius.patrius.utils.legs

Interface TimeSequence<T extends TimeStamped>

Type Parameters:

T - Any TimeStamped class.

All Superinterfaces:

Collection<T>, Iterable<T>

All Known Subinterfaces:

LegsSequence<L>

All Known Implementing Classes:

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

public interface TimeSequence<T extends TimeStamped>
extends Collection<T>

A Collection of TimeStamped objects.

This sequence is designed to sort objects by their date (TimeStamped.getDate()). Some might suggest that a NavigableSet would have done the job, but a NavigableSet has some methods too complicated and too ambiguous to implement (as lower(), floor(), …) with “time-sorted” objects.

Besides, as stated in the SortedSet interface documentation, the used Comparator must be “consistent with equals”, and it cannot be achieved with such TimeStamped objects.

Since:

4.7

Author:

Julien Anxionnat (CNES — DSO/DV/MP)

See Also:

TimeStamped, LegsSequence

Method Summary

Modifier and Type	Method and Description
default boolean	contains(Object o)
default boolean	containsAll(Collection<?> c)
TimeSequence<T>	copy() Returns a copy of the sequence.
T	first() Returns the first element currently in this sequence.
T	first(TimeStamped t) Returns the first element after the given date.
TimeSequence<T>	head(T toT) Returns a new sequence from the beginning to the given element.
T	last() Returns the last element currently in this sequence.
T	last(TimeStamped t) Returns the last element before the given date.
T	next(T t) Returns the strictly next element.
T	previous(T t) Returns the strictly previous element.
Set<T>	simultaneous(TimeStamped t) Returns all simultaneous elements.
TimeSequence<T>	sub(T fromT, T toT) Returns a new sequence extracted.
TimeSequence<T>	tail(T fromT) Returns a new sequence from the given element through the end.
default String	toPrettyString()

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

first

T first()

Returns the first element currently in this sequence.

Returns:

The first element currently in this sequence.

last

T last()

Returns the last element currently in this sequence.

Returns:

The last element currently in this sequence.

first

T first(TimeStamped t)

Returns the first element after the given date.

See next(TimeStamped) for “strict” comparison.

Parameters:

t - A date from any TimeStamped object.

Returns:

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

last

T last(TimeStamped t)

Returns the last element before the given date.

See previous(TimeStamped) for “strict” comparison.

Parameters:

t - A date from any TimeStamped object.

Returns:

The last element starting after (or at) the given date t.

simultaneous

Set<T> simultaneous(TimeStamped t)

Returns all simultaneous elements.

Parameters:

t - Time value to match. Not necessarily an element contained in the sequence.

Returns:

All elements at time t. If t is an element of the sequence, it’s among the returned elements.

previous

T previous(T t)

Returns the strictly previous element.

Parameters:

t - Any element of this sequence.

Returns:

The previous element of the given one, null if none. It’s a strictly previous: its date is strictly lower. Note also there may be simultaneous elements…

next

T next(T t)

Returns the strictly next element.

Parameters:

t - Any element of this sequence.

Returns:

The previous element of the given one, null if none. It’s a strictly next: its date is strictly upper. Note also there may be simultaneous elements…

head

TimeSequence<T> head(T toT)

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

Parameters:

toT - Any element of this sequence.

Returns:

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

tail

TimeSequence<T> tail(T fromT)

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

Parameters:

fromT - Any element of this sequence.

Returns:

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

sub

TimeSequence<T> sub(T fromT,
                    T toT)

Returns a new sequence extracted.

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

contains

default boolean contains(Object o)

Specified by:

contains in interface Collection<T extends TimeStamped>

containsAll

default boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<T extends TimeStamped>

toPrettyString

default String toPrettyString()

Returns:

A nice String representation.

copy

TimeSequence<T> copy()

Returns a copy of the sequence.

Returns:

a copy of the sequence.