Package org.orekit.propagation.events.handlers

Class FieldSecondaryEventLogger<T extends CalculusFieldElement<T>>

java.lang.Object

org.orekit.propagation.events.handlers.FieldSecondaryEventLogger<T>

All Implemented Interfaces:

FieldEventHandler<T>

public class FieldSecondaryEventLogger<T extends CalculusFieldElement<T>>
extends Object
implements FieldEventHandler<T>

Event handler logging primary and secondary positional information.

Since:

13.1

Author:

Romain Serra

See Also:

SecondaryEventLogger

Constructor Summary

Constructors

Constructor	Description
FieldSecondaryEventLogger(FieldPVCoordinatesProvider<T> secondaryPVCoordinatesProvider)	Constructor with default Action (CONTINUE).
FieldSecondaryEventLogger(FieldPVCoordinatesProvider<T> secondaryPVCoordinatesProvider, Action action)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	clearLogs()	Method to clear logs.
List<Pair<FieldAbsolutePVCoordinates<T>,FieldPVCoordinates<T>>>	copyLogs()	Method to copy logs.
Action	eventOccurred(FieldSpacecraftState<T> s, FieldEventDetector<T> detector, boolean increasing)	Handle an event.
void	finish(FieldSpacecraftState<T> finalState, FieldEventDetector<T> detector)	This method finalize event handler at the end of a propagation.
FieldPVCoordinatesProvider<T>	getSecondaryPVCoordinatesProvider()	Getter for the secondary trajectory provider.
void	init(FieldSpacecraftState<T> initialState, FieldAbsoluteDate<T> target, FieldEventDetector<T> 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.FieldEventHandler

resetState

Constructor Detail

FieldSecondaryEventLogger

public FieldSecondaryEventLogger(FieldPVCoordinatesProvider<T> secondaryPVCoordinatesProvider,
                                 Action action)

Constructor.

Parameters:

secondaryPVCoordinatesProvider - provider for secondary trajectory

action - action to return when event occurs

FieldSecondaryEventLogger

public FieldSecondaryEventLogger(FieldPVCoordinatesProvider<T> 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<FieldAbsolutePVCoordinates<T>,FieldPVCoordinates<T>>> copyLogs()

Method to copy logs.

Returns:

copy of logs

getSecondaryPVCoordinatesProvider

public FieldPVCoordinatesProvider<T> getSecondaryPVCoordinatesProvider()

Getter for the secondary trajectory provider.

Returns:

secondary

init

public void init(FieldSpacecraftState<T> initialState,
                 FieldAbsoluteDate<T> target,
                 FieldEventDetector<T> detector)

Description copied from interface: FieldEventHandler

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 FieldEventHandler<T extends CalculusFieldElement<T>>

Parameters:

initialState - initial state

target - target date for the propagation

detector - event detector related to the event handler

finish

public void finish(FieldSpacecraftState<T> finalState,
                   FieldEventDetector<T> detector)

Description copied from interface: FieldEventHandler

This method finalize event handler at the end of a propagation.

The default implementation does nothing

Specified by:

finish in interface FieldEventHandler<T extends CalculusFieldElement<T>>

Parameters:

finalState - state at propagation end

detector - event detector related to the event handler

eventOccurred

public Action eventOccurred(FieldSpacecraftState<T> s,
                            FieldEventDetector<T> detector,
                            boolean increasing)

Description copied from interface: FieldEventHandler

Handle an event.

Specified by:

eventOccurred in interface FieldEventHandler<T extends CalculusFieldElement<T>>

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