Package org.orekit.propagation.events
Enum FilterType
- java.lang.Object
-
- java.lang.Enum<FilterType>
-
- org.orekit.propagation.events.FilterType
-
- All Implemented Interfaces:
Serializable
,Comparable<FilterType>
public enum FilterType extends Enum<FilterType>
Enumerate forfiltering events
.This class is heavily based on the class with the same name from the Hipparchus library. The changes performed consist in package name and error handling.
- Since:
- 6.0
-
-
Enum Constant Summary
Enum Constants Enum Constant Description TRIGGER_ONLY_DECREASING_EVENTS
Constant for triggering only decreasing events.TRIGGER_ONLY_INCREASING_EVENTS
Constant for triggering only increasing events.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract boolean
getTriggeredIncreasing()
Get the increasing status of triggered events.protected abstract org.orekit.propagation.events.Transformer
selectTransformer(org.orekit.propagation.events.Transformer previous, double g, boolean forward)
Get next function transformer in the specified direction.static FilterType
valueOf(String name)
Returns the enum constant of this type with the specified name.static FilterType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
TRIGGER_ONLY_DECREASING_EVENTS
public static final FilterType TRIGGER_ONLY_DECREASING_EVENTS
Constant for triggering only decreasing events.When this filter is used, the wrapped
event handler
eventOccurred
method will be called only with itsincreasing
argument set to false.
-
TRIGGER_ONLY_INCREASING_EVENTS
public static final FilterType TRIGGER_ONLY_INCREASING_EVENTS
Constant for triggering only increasing events.When this filter is used, the wrapped
event handler
eventOccurred
method will be called only with itsincreasing
argument set to true.
-
-
Method Detail
-
values
public static FilterType[] 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 (FilterType c : FilterType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static FilterType 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
-
getTriggeredIncreasing
protected abstract boolean getTriggeredIncreasing()
Get the increasing status of triggered events.- Returns:
- true if triggered events are increasing events
-
selectTransformer
protected abstract org.orekit.propagation.events.Transformer selectTransformer(org.orekit.propagation.events.Transformer previous, double g, boolean forward)
Get next function transformer in the specified direction.- Parameters:
previous
- transformer active on the previous point with respect to integration direction (may be null if no previous point is known)g
- current value of the g functionforward
- true if integration goes forward- Returns:
- next transformer transformer
-
-