agi.foundation.segmentpropagation

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

Enum MaximumDurationBehavior

java.lang.Object

java.lang.Enum<MaximumDurationBehavior>

agi.foundation.segmentpropagation.MaximumDurationBehavior

All Implemented Interfaces:

Enumeration, Serializable, Comparable<MaximumDurationBehavior>

public enum MaximumDurationBehavior
extends Enum<MaximumDurationBehavior>
implements Enumeration

Defines the behavior that a NumericalPropagatorSegment should use when its MaximumDuration (get / set) is reached during propagation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
IGNORE_MAXIMUM_DURATION Ignore the MaximumDuration (get / set).
STOP_AND_CONTINUE_TO_NEXT_SEGMENT This will treat the MaximumDuration (get / set) as a normal StoppingCondition in that the propagation of the NumericalPropagatorSegment will stop and the next SegmentPropagator will continue propagating.
STOP_AND_RETURN This will stop the propagation of the NumericalPropagatorSegment and immediately return the results computed up to this point.
THROW This will throw a StoppedOnMaximumDurationException if the propagation of the SegmentPropagator exceeds its MaximumDuration (get / set).

Method Summary

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

STOP_AND_RETURN

public static final MaximumDurationBehavior STOP_AND_RETURN

This will stop the propagation of the NumericalPropagatorSegment and immediately return the results computed up to this point. No further propagation will continue.

STOP_AND_CONTINUE_TO_NEXT_SEGMENT

public static final MaximumDurationBehavior STOP_AND_CONTINUE_TO_NEXT_SEGMENT

This will treat the MaximumDuration (get / set) as a normal StoppingCondition in that the propagation of the NumericalPropagatorSegment will stop and the next SegmentPropagator will continue propagating.

THROW

public static final MaximumDurationBehavior THROW

This will throw a StoppedOnMaximumDurationException if the propagation of the SegmentPropagator exceeds its MaximumDuration (get / set).

IGNORE_MAXIMUM_DURATION

public static final MaximumDurationBehavior IGNORE_MAXIMUM_DURATION

Ignore the MaximumDuration (get / set). Note that if none of the StoppingConditions (get) are satisfied, then propagation may not stop until the program runs out of resources.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.