Package org.hipparchus.ode.events

Class EventOccurrence

java.lang.Object

org.hipparchus.ode.events.EventOccurrence

public class EventOccurrence
extends Object

Class to hold the data related to an event occurrence that is needed to decide how to modify integration.

Since:

3.O

Constructor Summary

Constructors

Constructor	Description
EventOccurrence(Action action, ODEState newState, double stopTime)	Create a new occurrence of an event.

Method Summary

Modifier and Type	Method	Description
Action	getAction()	Get the user requested action.
ODEState	getNewState()	Get the new state for a reset action.
double	getStopTime()	Get the new time for a stop action.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventOccurrence

public EventOccurrence(Action action,
                       ODEState newState,
                       double stopTime)

Create a new occurrence of an event.

Parameters:

action - the user requested action.

newState - for a reset event. Should be the current state unless the action is Action.RESET_STATE.

stopTime - to stop propagation if the action is Action.STOP. Used to move the stop time to just after the root.

Method Detail

getAction

public Action getAction()

Get the user requested action.

Returns:

the action.

getNewState

public ODEState getNewState()

Get the new state for a reset action.

Returns:

the new state.

getStopTime

public double getStopTime()

Get the new time for a stop action.

Returns:

when to stop propagation.