agi.foundation.segmentpropagation

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

Enum StateForNextSegmentBehavior

java.lang.Object

java.lang.Enum<StateForNextSegmentBehavior>

agi.foundation.segmentpropagation.StateForNextSegmentBehavior

All Implemented Interfaces:

Enumeration, Serializable, Comparable<StateForNextSegmentBehavior>

public enum StateForNextSegmentBehavior
extends Enum<StateForNextSegmentBehavior>
implements Enumeration

Enumerates the behaviors used in passing a state from one segment to another.

Enum Constant Summary

Enum Constants

Enum Constant and Description
PASS_FIRST_PROPAGATED_STATE Pass the initial state of the segment.
PASS_LAST_PROPAGATED_STATE Pass the final state of the segment.

Method Summary

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

PASS_LAST_PROPAGATED_STATE

public static final StateForNextSegmentBehavior PASS_LAST_PROPAGATED_STATE

Pass the final state of the segment.

PASS_FIRST_PROPAGATED_STATE

public static final StateForNextSegmentBehavior PASS_FIRST_PROPAGATED_STATE

Pass the initial state of the segment. This will generally be the state passed into the SegmentPropagator but adapted into the current segment's defined-ins (reference frames).

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.