fr.cnes.sirius.patrius.events.postprocessing

Class Timeline

java.lang.Object

fr.cnes.sirius.patrius.events.postprocessing.Timeline

public class Timeline
extends Object

Since:

1.1

Version:

$Id$

Author:

Julie Anton

Description :

This class represents the orbital events timeline as well as the associated phenomena when the event triggers a phenomenon.

Concurrency :

not thread-safe

Concurrency comment :

the timeline is not thread safe due to the methods removeCodedEvent(CodedEvent) and removePhenomenon(Phenomenon)

Constructor Summary

Constructors

Constructor and Description
Timeline(AbsoluteDateInterval interval) Builds an instance of Timeline from a single time interval.
Timeline(CodedEventsLogger logger, AbsoluteDateInterval interval, SpacecraftState spacecraftState) Builds an instance of the timeline from a CodedEventsLogger, generating the list of detected events and the list of corresponding phenomena. These events and phenomena are the output of a propagation with events detector; the coherence between events and phenomena should be guaranteed by the detection process during propagation.
Timeline(Timeline timeline) Builds an instance of the Timeline from another Timeline.
Timeline(Timeline timeline, AbsoluteDateInterval newInterval) Builds an instance Timeline from another Timeline with a wider validity time interval.

Method Summary

Modifier and Type	Method and Description
void	addCodedEvent(CodedEvent event)
void	addPhenomenon(Phenomenon phenomenon)
protected CodedEventsList	getCodedEvents()
List<CodedEvent>	getCodedEventsList()
AbsoluteDateInterval	getIntervalOfValidity()
protected PhenomenaList	getPhenomena()
protected List<String>	getPhenomenaCodes()
List<String>	getPhenomenaCodesList()
List<Phenomenon>	getPhenomenaList()
Timeline	join(Timeline otherTimeline) Buils a new Timeline by concatening this with the specified timeline.
void	merge(Timeline otherTimeline) Merges the provided timeline into this.
void	removeCodedEvent(CodedEvent event)
void	removeOnlyCodedEvent(CodedEvent event)
void	removePhenomenon(Phenomenon phenomenon)

Methods inherited from class java.lang.Object

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

Constructor Detail

Timeline

public Timeline(CodedEventsLogger logger,
                AbsoluteDateInterval interval,
                SpacecraftState spacecraftState)
         throws PatriusException

Builds an instance of the timeline from a CodedEventsLogger, generating the list of detected events and the list of corresponding phenomena.
These events and phenomena are the output of a propagation with events detector; the coherence between events and phenomena should be guaranteed by the detection process during propagation.

Parameters:

logger - the CodedEventsLogger storing the events and phenomena created during propagation.

interval - the AbsoluteDateInterval representing the validity interval of the events/phenomena lists.

spacecraftState - a spacecraft state using if there is no event in logger, may be null.

Throws:

PatriusException - if a problem occurs when g is called when building phenomena.

Timeline

public Timeline(Timeline timeline)

Builds an instance of the Timeline from another Timeline.

Parameters:

timeline - the timeline to copy

Timeline

public Timeline(AbsoluteDateInterval interval)

Builds an instance of Timeline from a single time interval. The lists of phenomena and events are empties.

Parameters:

interval - the AbsoluteDateInterval representing the validity interval of the events/phenomena lists.

Timeline

public Timeline(Timeline timeline,
                AbsoluteDateInterval newInterval)
         throws PatriusException

Builds an instance Timeline from another Timeline with a wider validity time interval. The phenomena and events stored in the provided timeline are copied.

Parameters:

timeline - the time line to copy.

newInterval - the new validity time interval.

Throws:

PatriusException - if the new validity interval does not include the one of the timeline.

Method Detail

getPhenomena

protected PhenomenaList getPhenomena()

Returns:

PhenomenaList

Description :

Get the phenomena list.

getCodedEvents

protected CodedEventsList getCodedEvents()

Returns:

CodedEventsList

Description :

Get the coded events list.

getPhenomenaCodes

protected List<String> getPhenomenaCodes()

Returns:

List of phenomena codes

Description :

Get the phenomena codes list.

getPhenomenaList

public List<Phenomenon> getPhenomenaList()

Returns:

list of phenomena

Description :

Get a copy of the phenomena list.

getCodedEventsList

public List<CodedEvent> getCodedEventsList()

Returns:

list of coded events

Description :

Get a copy of the coded events list

removeCodedEvent

public void removeCodedEvent(CodedEvent event)

Parameters:

event - : coded event that has to be removed from the list

Description :

Remove one coded event from the coded events list (as well as the phenomena list when the event triggers a phenomenon).

removeOnlyCodedEvent

public void removeOnlyCodedEvent(CodedEvent event)

Parameters:

event - : coded event that has to be removed from the list

Description :

Remove one coded event from the coded events list (without removing the associated phenomenon).

removePhenomenon

public void removePhenomenon(Phenomenon phenomenon)

Parameters:

phenomenon - : phenomenon that has to be removed from the list

Description :

Remove one phenomenon from the phenomena list as well as the associated coded events from the coded events list.

merge

public void merge(Timeline otherTimeline)
           throws PatriusException

Merges the provided timeline into this. The events and phenomena are added to this only if the validity time intervals are equals.

Parameters:

otherTimeline - the timeline to be merged.

Throws:

PatriusException - if the validity time intervals are not strictly equal

join

public Timeline join(Timeline otherTimeline)
              throws PatriusException

Buils a new Timeline by concatening this with the specified timeline. To concatenate two timelines, their validity time intervals must not overlap (an exception is thrown otherwise). The new timeline stores the phenomena/events of both timelines.

Parameters:

otherTimeline - the timeline to concatenate.

Returns:

the new timeline.

Throws:

PatriusException - if time intervals overlap.

addCodedEvent

public void addCodedEvent(CodedEvent event)

Parameters:

event - : event that has to be added to the list

Description :

Add one event to the events list

addPhenomenon

public void addPhenomenon(Phenomenon phenomenon)

Parameters:

phenomenon - : phenomenon that has to be added to the list

Description :

Add one phenomenon to the phenomena list (without adding the ending and starting events to the event list)

getIntervalOfValidity

public AbsoluteDateInterval getIntervalOfValidity()

Returns:

the interval of validity

Description :

Get the interval of validity.

getPhenomenaCodesList

public List<String> getPhenomenaCodesList()

Returns:

the interval of validity

Description :

Get the list of codes corresponding to the detected phenomena.