SRM

Enum SRM_Coordinate_Valid_Region_Code

java.lang.Object

java.lang.Enum<SRM_Coordinate_Valid_Region_Code>

SRM.SRM_Coordinate_Valid_Region_Code

All Implemented Interfaces:

Serializable, Comparable<SRM_Coordinate_Valid_Region_Code>

public enum SRM_Coordinate_Valid_Region_Code
extends Enum<SRM_Coordinate_Valid_Region_Code>

Enum Constant Summary

Enum Constants

Enum Constant and Description
COORDVALRGN_DEFINED DEFINED denotes a coordinate that is contained in the CS domain but not in the valid or the extended valid regions.
COORDVALRGN_EXTENDED_VALID EXTENDED_VALID denotes a coordinate that is contained in the extended valid region and in the CS domain but not in the valid region.
COORDVALRGN_VALID VALID denotes a coordinate that is contained in the valid region and in the CS domain.

Field Summary

Fields

Modifier and Type	Field and Description
static int	_totalEnum

Method Summary

Methods

Modifier and Type	Method and Description
static SRM_Coordinate_Valid_Region_Code	getEnum(int item)
int	toInt() returns the integer code value for the enumerant
static SRM_Coordinate_Valid_Region_Code	valueOf(String name) Returns the enum constant of this type with the specified name.
static SRM_Coordinate_Valid_Region_Code[]	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

COORDVALRGN_VALID

public static final SRM_Coordinate_Valid_Region_Code COORDVALRGN_VALID

VALID denotes a coordinate that is contained in the valid region and in the CS domain.

COORDVALRGN_EXTENDED_VALID

public static final SRM_Coordinate_Valid_Region_Code COORDVALRGN_EXTENDED_VALID

EXTENDED_VALID denotes a coordinate that is contained in the extended valid region and in the CS domain but not in the valid region.

COORDVALRGN_DEFINED

public static final SRM_Coordinate_Valid_Region_Code COORDVALRGN_DEFINED

DEFINED denotes a coordinate that is contained in the CS domain but not in the valid or the extended valid regions.

Field Detail

_totalEnum

public static final int _totalEnum

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static SRM_Coordinate_Valid_Region_Code 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

getEnum

public static SRM_Coordinate_Valid_Region_Code getEnum(int item)
                                                throws SrmException

Returns:

the SRM_Coordinate_Valid_Region_Code object from its enumerant value

Throws:

SrmException

toInt

public int toInt()

returns the integer code value for the enumerant