agi.foundation.geometry

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

Enum DisplacementVectorParticipant

java.lang.Object

java.lang.Enum<DisplacementVectorParticipant>

agi.foundation.geometry.DisplacementVectorParticipant

All Implemented Interfaces:

Enumeration, Serializable, Comparable<DisplacementVectorParticipant>

public enum DisplacementVectorParticipant
extends Enum<DisplacementVectorParticipant>
implements Enumeration

Identifies a participant in a VectorDisplacement.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FINAL_POINT The FinalPoint (get / set).
INITIAL_POINT The InitialPoint (get / set).

Method Summary

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

INITIAL_POINT

public static final DisplacementVectorParticipant INITIAL_POINT

The InitialPoint (get / set).

FINAL_POINT

public static final DisplacementVectorParticipant FINAL_POINT

The FinalPoint (get / set).

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.