fr.cnes.sirius.patrius.events.postprocessing

Class CodedEventsLogger.LoggedCodedEvent

java.lang.Object

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

All Implemented Interfaces:

TimeStamped, Comparable<CodedEventsLogger.LoggedCodedEvent>

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

Modifier and Type	Method and Description
int	compareTo(CodedEventsLogger.LoggedCodedEvent o) Compare two LoggedCodedEvent with their internal date.
boolean	equals(Object object) Note: only the date is evaluated.
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.
int	hashCode() Note: only the date is hashed.
boolean	isIncreasing() Tells if g increases or decreases around event date.

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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()

Get the date.

Specified by:

getDate in interface TimeStamped

Returns:

date attached to the object

compareTo

public int compareTo(CodedEventsLogger.LoggedCodedEvent o)

Compare two LoggedCodedEvent with their internal date.

Specified by:

compareTo in interface Comparable<CodedEventsLogger.LoggedCodedEvent>

Parameters:

o - LoggedCodedEvent to be compared with the instance

Returns:

a negative integer or a positive integer as the internal date is less than or greater than the internal date of the specified LoggedCodedEvent. When the dates are the same, returns 1.

equals

public boolean equals(Object object)

Note: only the date is evaluated.

Overrides:

equals in class Object

hashCode

public int hashCode()

Note: only the date is hashed.

Overrides:

hashCode in class Object