agi.foundation.navigation

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

Enum ConfidenceIntervalVariableDimension

java.lang.Object

java.lang.Enum<ConfidenceIntervalVariableDimension>

agi.foundation.navigation.ConfidenceIntervalVariableDimension

All Implemented Interfaces:

Enumeration, Serializable, Comparable<ConfidenceIntervalVariableDimension>

public enum ConfidenceIntervalVariableDimension
extends Enum<ConfidenceIntervalVariableDimension>
implements Enumeration

Signifies the dimension of a variable for the confidence interval calculation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ONE One dimensional variable
THREE Three dimensional variable
TWO Two dimensional variable

Method Summary

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

ONE

public static final ConfidenceIntervalVariableDimension ONE

One dimensional variable

TWO

public static final ConfidenceIntervalVariableDimension TWO

Two dimensional variable

THREE

public static final ConfidenceIntervalVariableDimension THREE

Three dimensional variable

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.