agi.foundation.numericalmethods.advanced

(agi.foundation.core-2024r3.jar)

Enum BehaviorWhenOnThreshold

java.lang.Object

java.lang.Enum<BehaviorWhenOnThreshold>

agi.foundation.numericalmethods.advanced.BehaviorWhenOnThreshold

All Implemented Interfaces:

Enumeration, Serializable, Comparable<BehaviorWhenOnThreshold>

public enum BehaviorWhenOnThreshold
extends Enum<BehaviorWhenOnThreshold>
implements Enumeration

Indicates the behavior of a function explorer such as JulianDateFunctionExplorer when a function value exactly equals a threshold value.

Enum Constant Summary

Enum Constants

Enum Constant and Description
TREAT_AS_ABOVE Indicates that a function value that is exactly equal to the threshold is treated as being ABOVE the threshold.
TREAT_AS_BELOW Indicates that a function value that is exactly equal to the threshold is threated as being BELOW the threshold.

Method Summary

Modifier and Type	Method and Description
static BehaviorWhenOnThreshold	getDefault() Get the enum constant that is considered to be the default.
static BehaviorWhenOnThreshold	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static BehaviorWhenOnThreshold	valueOf(String name) Returns the enum constant of this type with the specified name.
static BehaviorWhenOnThreshold[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TREAT_AS_ABOVE

public static final BehaviorWhenOnThreshold TREAT_AS_ABOVE

Indicates that a function value that is exactly equal to the threshold is treated as being ABOVE the threshold. In other words, a crossing will be indicated when the function goes from being below the threshold to being on it, but will NOT be indicated when the function goes from being above the threshold to being on it.

TREAT_AS_BELOW

public static final BehaviorWhenOnThreshold TREAT_AS_BELOW

Indicates that a function value that is exactly equal to the threshold is threated as being BELOW the threshold. In other words, a crossing will be indicated when the function goes from being above the threshold to being on it, but will NOT be indicated when the function goes from being below the threshold to being on it.

Method Detail

values

public static BehaviorWhenOnThreshold[] 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 (BehaviorWhenOnThreshold c : BehaviorWhenOnThreshold.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BehaviorWhenOnThreshold 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 name

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static BehaviorWhenOnThreshold getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static BehaviorWhenOnThreshold getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.