agi.foundation.segmentpropagation

(agi.foundation.segmentpropagation-2024r2.jar)

Enum TargetedSegmentListOperatorBehavior

java.lang.Object

java.lang.Enum<TargetedSegmentListOperatorBehavior>

agi.foundation.segmentpropagation.TargetedSegmentListOperatorBehavior

All Implemented Interfaces:

Enumeration, Serializable, Comparable<TargetedSegmentListOperatorBehavior>

public enum TargetedSegmentListOperatorBehavior
extends Enum<TargetedSegmentListOperatorBehavior>
implements Enumeration

Defines the behavior of the operators in the TargetedSegmentList. These options are mainly for operators that compute iteratively, such as the TargetedSegmentListDifferentialCorrector.

Enum Constant Summary

Enum Constants

Enum Constant and Description
RUN_ACTIVE_OPERATORS This will run all of the operators normally.
RUN_ACTIVE_OPERATORS_ONCE This will run each operators once, only allowing them to run a single iteration.
RUN_NOMINAL_SEQUENCE This will run all of the operators once with whatever values it is set with.

Method Summary

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

RUN_ACTIVE_OPERATORS

public static final TargetedSegmentListOperatorBehavior RUN_ACTIVE_OPERATORS

This will run all of the operators normally. When each operator finishes, the next will run, and the overall propagation will continue after the final operator finishes.

RUN_ACTIVE_OPERATORS_ONCE

public static final TargetedSegmentListOperatorBehavior RUN_ACTIVE_OPERATORS_ONCE

This will run each operators once, only allowing them to run a single iteration. If the operator does not work in an iterative fashion, then it will run normally.

RUN_NOMINAL_SEQUENCE

public static final TargetedSegmentListOperatorBehavior RUN_NOMINAL_SEQUENCE

This will run all of the operators once with whatever values it is set with. If the operator iterates to a solution, no iteration will occur. For operators that are not iterative, they will run normally.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.