fr.cnes.sirius.patrius.utils.legs

Class StrictLegsSequence<L extends Leg>

java.lang.Object

fr.cnes.sirius.patrius.utils.legs.StrictLegsSequence<L>

Type Parameters:

L - Any Leg class.

All Implemented Interfaces:

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

Direct Known Subclasses:

OrientationAngleLegsSequence, OrientationAngleProfileSequence, StrictAttitudeLegsSequence

public class StrictLegsSequence<L extends Leg>
extends Object
implements LegsSequence<L>

A LegsSequence which does not accept simultaneous or overlapping legs. Legs are considered to have closed boundaries.

Author:

Julien Anxionnat (CNES — DSO/DV/MP)

See Also:

Leg, LegsSequence

Constructor Summary

Constructors

Constructor and Description
StrictLegsSequence() Create a new empty sequence.

Method Summary

Modifier and Type	Method and Description
boolean	add(L leg)
boolean	addAll(Collection<? extends L> legs) This addAll(…) method is not supported, since it’s an optional operation as stated in Collection.addAll(Collection).
void	clear()
StrictLegsSequence<L>	copy() Returns a copy of the sequence.
StrictLegsSequence<L>	copy(AbsoluteDateInterval newInterval) Creates a new legs sequence from this one.
StrictLegsSequence<L>	copy(AbsoluteDateInterval newInterval, boolean strict) Creates a new legs sequence from this one.
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.
NavigableSet<TimeStamped>	getSet() Getter
AbsoluteDateInterval	getTimeInterval() Returns the time interval of the legs sequence.
LegsSequence<L>	head(AbsoluteDate toT, boolean strict) Returns a new sequence from the beginning to the given element.
LegsSequence<L>	head(L toLeg) Returns a new sequence from the beginning to the given element.
boolean	isEmpty()
boolean	isEmpty(AbsoluteDate date, AbsoluteDate end) Checks whether the sequence is free on the given interval or not.
Iterator<L>	iterator()
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.
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c) This addAll(…) method is not supported, since it’s an optional operation as stated in Collection.retainAll(Collection).
Set<L>	simultaneous(L leg) Such a StrictLegsSequence cannot have simultaneous legs!
Set<L>	simultaneous(TimeStamped t) Such a StrictLegsSequence cannot have simultaneous legs.
int	size()
LegsSequence<L>	sub(AbsoluteDate fromT, AbsoluteDate toT, boolean strict) Returns a new sequence extracted.
LegsSequence<L>	sub(AbsoluteDateInterval interval, boolean strict) Returns a new sequence extracted.
LegsSequence<L>	sub(L fromLeg, L toLeg) Returns a new sequence extracted.
LegsSequence<L>	tail(AbsoluteDate fromT, boolean strict) Returns a new sequence from the given element to the end of the sequence.
LegsSequence<L>	tail(L fromLeg) Returns a new sequence from the given element through the end.
Object[]	toArray()
<T> T[]	toArray(T[] a)
String	toPrettyString()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

head, sub, sub, tail

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

StrictLegsSequence

public StrictLegsSequence()

Create a new empty sequence.

Method Detail

current

public L current(TimeStamped t)

Returns the current leg at the given date.

Specified by:

current in interface LegsSequence<L extends Leg>

Parameters:

t - A date from any TimeStamped object.

Returns:

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

first

public L first()

Returns the first element currently in this sequence.

Specified by:

first in interface LegsSequence<L extends Leg>

Specified by:

first in interface TimeSequence<L extends Leg>

Returns:

The first Leg, null if none.

last

public L last()

Returns the last element currently in this sequence.

Specified by:

last in interface LegsSequence<L extends Leg>

Specified by:

last in interface TimeSequence<L extends Leg>

Returns:

The last Leg, null if none.

first

public L first(TimeStamped t)

Returns the first element after the given date.

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

Specified by:

first in interface LegsSequence<L extends Leg>

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

public L last(TimeStamped t)

Returns the last element before the given date.

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

Specified by:

last in interface LegsSequence<L extends Leg>

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

public Set<L> simultaneous(L leg)

Such a StrictLegsSequence cannot have simultaneous legs!

Specified by:

simultaneous in interface LegsSequence<L extends Leg>

Parameters:

leg - A Leg of this sequence.

Returns:

Since a StrictLegsSequence cannot have simultaneous legs, the returned Set is a HashSet containing just the given leg.

Throws:

IllegalArgumentException - If leg is null or sequence is not empty and does not contain leg.

See Also:

LegsSequence.simultaneous(Leg)

simultaneous

public Set<L> simultaneous(TimeStamped t)

Such a StrictLegsSequence cannot have simultaneous legs.

Warning: legs are considered to have closed boundaries. For instance a sequence ]a, b[ U ]b, c[ and t = b will return the second leg although b is not in the sequence.

Specified by:

simultaneous in interface TimeSequence<L extends Leg>

Parameters:

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

Returns:

The leg at time t, if any. (If t is a leg of the sequence, it’s the returned one.)

See Also:

TimeSequence.simultaneous(TimeStamped)

previous

public L previous(L leg)

Returns the strictly previous element.

Specified by:

previous in interface LegsSequence<L extends Leg>

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

public L next(L leg)

Returns the strictly next element.

Specified by:

next in interface LegsSequence<L extends Leg>

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

public LegsSequence<L> head(L toLeg)

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

Specified by:

head in interface LegsSequence<L extends Leg>

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

head

public LegsSequence<L> head(AbsoluteDate toT,
                            boolean strict)

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

Specified by:

head in interface LegsSequence<L extends Leg>

Parameters:

toT - Any element of this sequence.

strict - true if boundary shall not be included in the extracted sequence, false otherwise.

Returns:

A new Sequence object including all elements from the “beginning” to the given one (included only if strict = false).

tail

public LegsSequence<L> tail(L fromLeg)

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

Specified by:

tail in interface LegsSequence<L extends Leg>

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

tail

public LegsSequence<L> tail(AbsoluteDate fromT,
                            boolean strict)

Returns a new sequence from the given element to the end of the sequence.

Specified by:

tail in interface LegsSequence<L extends Leg>

Parameters:

fromT - Any element of this sequence.

strict - true if boundary shall not be included in the extracted sequence, false otherwise.

Returns:

A new Sequence object including all elements from the given one (included only if strict = false) to the “end” of the sequence.

sub

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

Returns a new sequence extracted.

Specified by:

sub in interface LegsSequence<L extends Leg>

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

sub

public LegsSequence<L> sub(AbsoluteDate fromT,
                           AbsoluteDate toT,
                           boolean strict)

Returns a new sequence extracted.

Specified by:

sub in interface LegsSequence<L extends Leg>

Parameters:

fromT - Any element of this sequence.

toT - Any element of this sequence.

strict - true if boundaries shall not be included in the extracted sequence, false otherwise.

Returns:

A new Sequence object including all elements from the given one fromT to the given one. Elements exactly on the interval boundaries are included only if strict = false.

sub

public LegsSequence<L> sub(AbsoluteDateInterval interval,
                           boolean strict)

Returns a new sequence extracted.

Specified by:

sub in interface LegsSequence<L extends Leg>

Parameters:

interval - interval.

strict - true if boundaries shall not be included in the extracted sequence, false otherwise.

Returns:

A new Sequence object including all elements included in the interval . Elements exactly on the interval boundaries are included only if strict = false.

isEmpty

public boolean isEmpty(AbsoluteDate date,
                       AbsoluteDate end)

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

Specified by:

isEmpty in interface LegsSequence<L extends Leg>

Parameters:

date - The “beginning” date.

end - The “end” date.

Returns:

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

add

public boolean add(L leg)

Specified by:

add in interface Collection<L extends Leg>

addAll

public boolean addAll(Collection<? extends L> legs)

This addAll(…) method is not supported, since it’s an optional operation as stated in Collection.addAll(Collection).

Specified by:

addAll in interface Collection<L extends Leg>

clear

public void clear()

Specified by:

clear in interface Collection<L extends Leg>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<L extends Leg>

iterator

public Iterator<L> iterator()

Specified by:

iterator in interface Iterable<L extends Leg>

Specified by:

iterator in interface Collection<L extends Leg>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<L extends Leg>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<L extends Leg>

retainAll

public boolean retainAll(Collection<?> c)

This addAll(…) method is not supported, since it’s an optional operation as stated in Collection.retainAll(Collection).

Specified by:

retainAll in interface Collection<L extends Leg>

size

public int size()

Specified by:

size in interface Collection<L extends Leg>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<L extends Leg>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<L extends Leg>

toPrettyString

public String toPrettyString()

Specified by:

toPrettyString in interface LegsSequence<L extends Leg>

Specified by:

toPrettyString in interface TimeSequence<L extends Leg>

Returns:

A nice String representation.

toString

public String toString()

Overrides:

toString in class Object

Returns:

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

Specified by:

getTimeInterval in interface LegsSequence<L extends Leg>

Returns:

the time interval of the legs sequence.

copy

public StrictLegsSequence<L> copy()

Returns a copy of the sequence.

Specified by:

copy in interface LegsSequence<L extends Leg>

Specified by:

copy in interface TimeSequence<L extends Leg>

Returns:

a copy of the sequence.

copy

public StrictLegsSequence<L> copy(AbsoluteDateInterval newInterval,
                                  boolean strict)

Creates a new legs sequence from this one.

Specified by:

copy in interface LegsSequence<L extends Leg>

Parameters:

newInterval - The time interval of the legs sequence to create

strict - true if boundaries shall not be included in the new sequence, false otherwise.

Returns:

A new LegsSequence valid on provided interval

copy

public StrictLegsSequence<L> copy(AbsoluteDateInterval newInterval)

Creates a new legs sequence from this one.

Specified by:

copy in interface LegsSequence<L extends Leg>

Parameters:

newInterval - The time interval of the legs sequence to create

Returns:

A new LegsSequence valid on provided interval. Boundaries are not included in the new sequence.

getSet

public NavigableSet<TimeStamped> getSet()

Getter

Returns:

the set