agi.foundation.propagators

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

Enum PropagationEventTrigger

java.lang.Object

java.lang.Enum<PropagationEventTrigger>

agi.foundation.propagators.PropagationEventTrigger

All Implemented Interfaces:

Enumeration, Serializable, Comparable<PropagationEventTrigger>

public enum PropagationEventTrigger
extends Enum<PropagationEventTrigger>
implements Enumeration

Indicates which kind of propagation method triggered the StepTaken (add / remove) event.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NEW_STEP Indicates that the event was triggered by taking a new step to advance the state.
RESTEP Indicates that the event was triggered by the propagator repropagating the previous step.

Method Summary

Modifier and Type	Method and Description
static PropagationEventTrigger	getDefault() Get the enum constant that is considered to be the default.
static PropagationEventTrigger	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 PropagationEventTrigger	valueOf(String name) Returns the enum constant of this type with the specified name.
static PropagationEventTrigger[]	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

NEW_STEP

public static final PropagationEventTrigger NEW_STEP

Indicates that the event was triggered by taking a new step to advance the state.

RESTEP

public static final PropagationEventTrigger RESTEP

Indicates that the event was triggered by the propagator repropagating the previous step.

Method Detail

values

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

Returns:

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

valueOf

public static PropagationEventTrigger 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 PropagationEventTrigger 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 PropagationEventTrigger getDefault()

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

Returns:

The default enum constant.