agi.foundation.routedesign.advanced

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

Enum SurfaceProcedureConnectionDependency

java.lang.Object

java.lang.Enum<SurfaceProcedureConnectionDependency>

agi.foundation.routedesign.advanced.SurfaceProcedureConnectionDependency

All Implemented Interfaces:

Enumeration, Serializable, Comparable<SurfaceProcedureConnectionDependency>

public enum SurfaceProcedureConnectionDependency
extends Enum<SurfaceProcedureConnectionDependency>
implements Enumeration

An enumeration indicating how one surface procedure depends on another. Depending on whether a given procedure is defined by its entry or exit, it may require the previous or the next connection to be configured first.

The RoutePropagator will attempt to configure the RouteProcedures in the most efficient order based on their dependency.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH_CONNECTIONS_NEEDED The current procedure requires that both entry and exit are required to fully define the procedure geometry, which usually indicates that either the entry or exit may need to be reconfigured based on the overall result.
NEXT_CONNECTION_FIRST The current procedure requires that its exit geometry be configured prior to anything else.
NO_DEPENDENCY The geometry of the current procedure does not depend on the previous or next connection and configuration can proceed in any order.
PREVIOUS_CONNECTION_FIRST The current procedure requires that its entry geometry be configured prior to anything else.

Method Summary

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

PREVIOUS_CONNECTION_FIRST

public static final SurfaceProcedureConnectionDependency PREVIOUS_CONNECTION_FIRST

The current procedure requires that its entry geometry be configured prior to anything else.

NEXT_CONNECTION_FIRST

public static final SurfaceProcedureConnectionDependency NEXT_CONNECTION_FIRST

The current procedure requires that its exit geometry be configured prior to anything else.

BOTH_CONNECTIONS_NEEDED

public static final SurfaceProcedureConnectionDependency BOTH_CONNECTIONS_NEEDED

The current procedure requires that both entry and exit are required to fully define the procedure geometry, which usually indicates that either the entry or exit may need to be reconfigured based on the overall result.

NO_DEPENDENCY

public static final SurfaceProcedureConnectionDependency NO_DEPENDENCY

The geometry of the current procedure does not depend on the previous or next connection and configuration can proceed in any order.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.