fr.cnes.sirius.patrius.events.multi
Class MultiCodedEventsLogger.MultiLoggedCodedEvent

java.lang.Object
  fr.cnes.sirius.patrius.events.multi.MultiCodedEventsLogger.MultiLoggedCodedEvent

All Implemented Interfaces:

Comparable<MultiCodedEventsLogger.MultiLoggedCodedEvent>, TimeStamped

Enclosing class:

MultiCodedEventsLogger

public static final class MultiCodedEventsLogger.MultiLoggedCodedEvent
extends Object
implements TimeStamped, Comparable<MultiCodedEventsLogger.MultiLoggedCodedEvent>

This class is used to store the coded event with contextual information.

See Also:

CodedEvent, MultiCodingEventDetector, Phenomenon, AbsoluteDate

Concurrency :

not thread-safe

Method Summary

int	compareTo(MultiCodedEventsLogger.MultiLoggedCodedEvent o) Compare two MultiLoggedCodedEvent with their internal date.
CodedEvent	getCodedEvent() Gets the coded event in multi propagation context.
AbsoluteDate	getDate() Get the date.
MultiCodingEventDetector	getMultiDetector() Gets the MultiCodingEventDetector that generated the coded event.
Map<String,SpacecraftState>	getStates() Gets the map of SpacecraftState that caused the coded event.
boolean	isIncreasing() Tells if g increases or decreases around event date.

Methods inherited from class java.lang.Object

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

Method Detail

getMultiDetector

public MultiCodingEventDetector getMultiDetector()

Gets the MultiCodingEventDetector that generated the coded event.

Returns:

the multi detector.

getStates

public Map<String,SpacecraftState> getStates()

Gets the map of SpacecraftState that caused the coded event.

Returns:

the states.

isIncreasing

public boolean isIncreasing()

Tells if g increases or decreases around event date.

Returns:

if true, g function increases around event date

getCodedEvent

public CodedEvent getCodedEvent()

Gets the coded event in multi propagation context.

Returns:

the coded event

compareTo

public int compareTo(MultiCodedEventsLogger.MultiLoggedCodedEvent o)

Compare two MultiLoggedCodedEvent with their internal date.

Specified by:

compareTo in interface Comparable<MultiCodedEventsLogger.MultiLoggedCodedEvent>

Parameters:

o - MultiLoggedCodedEvent to be compared with the instance

Returns:

a negative integer, zero, or a positive integer as the internal date is less than, equal to, or greater than the internal date of the specified MultiLoggedCodedEvent.

getDate

public AbsoluteDate getDate()

Description copied from interface: TimeStamped

Get the date.

Specified by:

getDate in interface TimeStamped

Returns:

date attached to the object