Package org.hipparchus.ode.events
Enum Action
- java.lang.Object
-
- java.lang.Enum<Action>
-
- org.hipparchus.ode.events.Action
-
- All Implemented Interfaces:
Serializable
,Comparable<Action>
public enum Action extends Enum<Action>
Enumerate for actions to be performed when an event occurs during ODE integration.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CONTINUE
Continue indicator.RESET_DERIVATIVES
Reset derivatives indicator.RESET_STATE
Reset state indicator.STOP
Stop indicator.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static Action
valueOf(String name)
Returns the enum constant of this type with the specified name.static Action[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
STOP
public static final Action STOP
Stop indicator.This value should be used as the return value of the
eventOccurred
method when the integration should be stopped after the event ending the current step.
-
RESET_STATE
public static final Action RESET_STATE
Reset state indicator.This value should be used as the return value of the
eventOccurred
} method when the integration should go on after the event ending the current step, with a new state vector (which will be retrieved thanks to theresetState
method).
-
RESET_DERIVATIVES
public static final Action RESET_DERIVATIVES
Reset derivatives indicator.This value should be used as the return value of the
eventOccurred
method when the integration should go on after the event ending the current step, with a new derivatives vector.
-
CONTINUE
public static final Action CONTINUE
Continue indicator.This value should be used as the return value of the
eventOccurred
method when the integration should go on after the event ending the current step.
-
-
Method Detail
-
values
public static Action[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (Action c : Action.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Action valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
-