Package org.orekit.propagation.events.handlers

Class SecondaryEventLogger

java.lang.Object

org.orekit.propagation.events.handlers.SecondaryEventLogger

All Implemented Interfaces:

EventHandler

public class SecondaryEventLogger
extends Object
implements EventHandler

Event handler logging primary and secondary positional information.

Since:

13.1

Author:

Romain Serra

Constructor Summary

Constructors

Constructor	Description
SecondaryEventLogger(PVCoordinatesProvider secondaryPVCoordinatesProvider)	Constructor with default Action (CONTINUE).
SecondaryEventLogger(PVCoordinatesProvider secondaryPVCoordinatesProvider, Action action)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	clearLogs()	Method to clear logs.
List<Pair<AbsolutePVCoordinates,PVCoordinates>>	copyLogs()	Method to copy logs.
Action	eventOccurred(SpacecraftState s, EventDetector detector, boolean increasing)	Handle an event.
void	finish(SpacecraftState finalState, EventDetector detector)	This method finalizes the event handler's job.
PVCoordinatesProvider	getSecondaryPVCoordinatesProvider()	Getter for the secondary trajectory provider.
void	init(SpacecraftState initialState, AbsoluteDate target, EventDetector detector)	Initialize event handler at the start of a propagation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orekit.propagation.events.handlers.EventHandler

resetState

Constructor Detail

SecondaryEventLogger

public SecondaryEventLogger(PVCoordinatesProvider secondaryPVCoordinatesProvider,
                            Action action)

Constructor.

Parameters:

secondaryPVCoordinatesProvider - provider for secondary trajectory

action - action to return when event occurs

SecondaryEventLogger

public SecondaryEventLogger(PVCoordinatesProvider secondaryPVCoordinatesProvider)

Constructor with default Action (CONTINUE).

Parameters:

secondaryPVCoordinatesProvider - provider for secondary trajectory

Method Detail

clearLogs

public void clearLogs()

Method to clear logs.

copyLogs

public List<Pair<AbsolutePVCoordinates,PVCoordinates>> copyLogs()

Method to copy logs.

Returns:

copy of logs

getSecondaryPVCoordinatesProvider

public PVCoordinatesProvider getSecondaryPVCoordinatesProvider()

Getter for the secondary trajectory provider.

Returns:

secondary

init

public void init(SpacecraftState initialState,
                 AbsoluteDate target,
                 EventDetector detector)

Description copied from interface: EventHandler

Initialize event handler at the start of a propagation.

This method is called once at the start of the propagation. It may be used by the event handler to initialize some internal data if needed.

The default implementation does nothing

Specified by:

init in interface EventHandler

Parameters:

initialState - initial state

target - target date for the propagation

detector - event detector related to the event handler

finish

public void finish(SpacecraftState finalState,
                   EventDetector detector)

Description copied from interface: EventHandler

This method finalizes the event handler's job.

The default implementation does nothing

Specified by:

finish in interface EventHandler

Parameters:

finalState - state at propagation end

detector - event detector related to the event handler

eventOccurred

public Action eventOccurred(SpacecraftState s,
                            EventDetector detector,
                            boolean increasing)

Description copied from interface: EventHandler

Handle an event.

Specified by:

eventOccurred in interface EventHandler

Parameters:

s - SpaceCraft state to be used in the evaluation

detector - object with appropriate type that can be used in determining correct return state

increasing - with the event occurred in an "increasing" or "decreasing" slope direction

Returns:

the Action that the calling detector should pass back to the evaluation system