Package org.orekit.propagation.events.handlers

Class CountingHandler

java.lang.Object

org.orekit.propagation.events.handlers.CountingHandler

All Implemented Interfaces:

EventHandler

public class CountingHandler
extends Object
implements EventHandler

Class for handlers counting event occurrences. The Action can be modified according to the count.

Since:

13.0

Author:

Romain Serra

Constructor Summary

Constructors

Constructor	Description
CountingHandler(int startingCount, Action action)	Constructor.
CountingHandler(Action action)	Constructor with initial count at zero.

Method Summary

Modifier and Type	Method	Description
protected boolean	doesCount(SpacecraftState state, EventDetector detector, boolean increasing)	Method returning true if and only if the count needs to be incremented.
Action	eventOccurred(SpacecraftState s, EventDetector detector, boolean increasing)	Handle an event.
protected Action	getAction()	Protected getter for the action to return.
int	getCount()	Getter for count.
protected void	increment()	Increment count.
void	reset()	Reset count.
protected void	setAction(Action action)	Protected setter for action.
void	setCount(int count)	Reset count.

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

finish, init, resetState

Constructor Detail

CountingHandler

public CountingHandler(Action action)

Constructor with initial count at zero.

Parameters:

action - Action to initialize attribute

CountingHandler

public CountingHandler(int startingCount,
                       Action action)

Constructor.

Parameters:

startingCount - value to initialize count

action - Action to initialize attribute

Method Detail

eventOccurred

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

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

doesCount

protected boolean doesCount(SpacecraftState state,
                            EventDetector detector,
                            boolean increasing)

Method returning true if and only if the count needs to be incremented. By default, count all.

Parameters:

state - state at detection

detector - detector

increasing - flag on direction of event function

Returns:

flag on counting

getCount

public int getCount()

Getter for count.

Returns:

count

getAction

protected Action getAction()

Protected getter for the action to return.

Returns:

action

setAction

protected void setAction(Action action)

Protected setter for action.

Parameters:

action - new action

setCount

public void setCount(int count)

Reset count.

Parameters:

count - new value

reset

public void reset()

Reset count.

increment

protected void increment()

Increment count.