fr.cnes.sirius.patrius.events
Class CodedEventsLogger.LoggedCodedEvent

java.lang.Object
  fr.cnes.sirius.patrius.events.CodedEventsLogger.LoggedCodedEvent

All Implemented Interfaces:

Comparable<CodedEventsLogger.LoggedCodedEvent>, TimeStamped

Enclosing class:

CodedEventsLogger

public static final class CodedEventsLogger.LoggedCodedEvent
extends Object
implements TimeStamped, Comparable<CodedEventsLogger.LoggedCodedEvent>

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

See Also:

CodedEvent, CodingEventDetector, Phenomenon, AbsoluteDate

Concurrency :

not thread-safe

Method Summary

int	compareTo(CodedEventsLogger.LoggedCodedEvent o)
CodedEvent	getCodedEvent() Gets the coded event.
AbsoluteDate	getDate() Get the date.
CodingEventDetector	getDetector() Gets the CodingEventDetector that generated the coded event.
SpacecraftState	getState() Gets the 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

getDetector

public CodingEventDetector getDetector()

Gets the CodingEventDetector that generated the coded event.

Returns:

the detector.

getState

public SpacecraftState getState()

Gets the SpacecraftState that caused the coded event.

Returns:

the state.

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.

Returns:

the coded event.

getDate

public AbsoluteDate getDate()

Description copied from interface: TimeStamped

Get the date.

Specified by:

getDate in interface TimeStamped

Returns:

date attached to the object

compareTo

public int compareTo(CodedEventsLogger.LoggedCodedEvent o)

Specified by:

compareTo in interface Comparable<CodedEventsLogger.LoggedCodedEvent>