Enum Class AddSpecificDimensionEnumerationsforSubsurfaceAreaSize

java.lang.Object

java.lang.Enum<AddSpecificDimensionEnumerationsforSubsurfaceAreaSize>

edu.nps.moves.dis7.enumerations.AddSpecificDimensionEnumerationsforSubsurfaceAreaSize

All Implemented Interfaces:

Serializable, Comparable<AddSpecificDimensionEnumerationsforSubsurfaceAreaSize>, Constable

public enum AddSpecificDimensionEnumerationsforSubsurfaceAreaSize
extends Enum<AddSpecificDimensionEnumerationsforSubsurfaceAreaSize>

This enum type is generated from XML, UID 133, marshal size 8; AddSpecificDimensionEnumerationsforSubsurfaceAreaSize has 6 enumerations total. The gaps in enumeration values are intentional and are reserved for future additions.

See Also:

• Java Tutorials: Enum Types
• Enum

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LARGE_SCHOOL_5KM_X_2KM_X_500M_10KM_X_4KM_X_1KM	Large School (5km x 2km x 500m - 10km x 4km x 1km)
LARGE_SCHOOL_DENSE_5KM_X_2KM_X_500M_10KM_X_4KM_X_1KM	Large School, Dense (5km x 2km x 500m - 10km x 4km x 1km)
MEDIUM_SCHOOL_5KM_X_1KM_X_125M_1KM_X_2KM_X_500M	Medium School (.5km x 1km x 125m - 1km x 2km x 500m)
MEDIUM_SCHOOL_DENSE_5KM_X_1KM_X_125M_1KM_X_2KM_X_500M	Medium School, Dense (.5km x 1km x 125m - 1km x 2km x 500m)
SMALL_SCHOOL_5KM_LONG_X_250M_WIDE_X_83M_DEEP_1KM_X_5KM_X_166M	Small School (.5km long x 250m wide x 83m deep - 1km x .5km x 166m)
SMALL_SCHOOL_DENSE_5KM_LONG_X_250M_WIDE_X_83M_DEEP_1KM_X_5KM_X_166M	Small School, Dense (.5km long x 250m wide x 83m deep - 1km x .5km x 166m)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Provide enumeration description
static int	getEnumBitWidth()	bit width for this enumeration
static AddSpecificDimensionEnumerationsforSubsurfaceAreaSize	getEnumForValue(int value)	Provide enumeration for a given value
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
String	getName()	Provide name
boolean	getTRACE()	Whether tracing is on or off for this object
int	getValue()	Provide enumeration value
void	marshal(DataOutputStream dos)	Marshal value to DataOutputStream
void	marshal(ByteBuffer byteBuffer)	Marshal value to ByteBuffer
void	setTRACE(boolean value)	Set tracing on/off for this object
String	toString()	Provide simple identifier
static AddSpecificDimensionEnumerationsforSubsurfaceAreaSize	unmarshalEnum(DataInputStream dis)	Unmarshal value to DataInputStream
static AddSpecificDimensionEnumerationsforSubsurfaceAreaSize	unmarshalEnum(ByteBuffer byteBuffer)	Unmarshal enumeration value to ByteBuffer
static AddSpecificDimensionEnumerationsforSubsurfaceAreaSize	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AddSpecificDimensionEnumerationsforSubsurfaceAreaSize[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SMALL_SCHOOL_5KM_LONG_X_250M_WIDE_X_83M_DEEP_1KM_X_5KM_X_166M

public static final AddSpecificDimensionEnumerationsforSubsurfaceAreaSize SMALL_SCHOOL_5KM_LONG_X_250M_WIDE_X_83M_DEEP_1KM_X_5KM_X_166M

Small School (.5km long x 250m wide x 83m deep - 1km x .5km x 166m)

SMALL_SCHOOL_DENSE_5KM_LONG_X_250M_WIDE_X_83M_DEEP_1KM_X_5KM_X_166M

public static final AddSpecificDimensionEnumerationsforSubsurfaceAreaSize SMALL_SCHOOL_DENSE_5KM_LONG_X_250M_WIDE_X_83M_DEEP_1KM_X_5KM_X_166M

Small School, Dense (.5km long x 250m wide x 83m deep - 1km x .5km x 166m)

MEDIUM_SCHOOL_5KM_X_1KM_X_125M_1KM_X_2KM_X_500M

public static final AddSpecificDimensionEnumerationsforSubsurfaceAreaSize MEDIUM_SCHOOL_5KM_X_1KM_X_125M_1KM_X_2KM_X_500M

Medium School (.5km x 1km x 125m - 1km x 2km x 500m)

MEDIUM_SCHOOL_DENSE_5KM_X_1KM_X_125M_1KM_X_2KM_X_500M

public static final AddSpecificDimensionEnumerationsforSubsurfaceAreaSize MEDIUM_SCHOOL_DENSE_5KM_X_1KM_X_125M_1KM_X_2KM_X_500M

Medium School, Dense (.5km x 1km x 125m - 1km x 2km x 500m)

LARGE_SCHOOL_5KM_X_2KM_X_500M_10KM_X_4KM_X_1KM

public static final AddSpecificDimensionEnumerationsforSubsurfaceAreaSize LARGE_SCHOOL_5KM_X_2KM_X_500M_10KM_X_4KM_X_1KM

Large School (5km x 2km x 500m - 10km x 4km x 1km)

LARGE_SCHOOL_DENSE_5KM_X_2KM_X_500M_10KM_X_4KM_X_1KM

public static final AddSpecificDimensionEnumerationsforSubsurfaceAreaSize LARGE_SCHOOL_DENSE_5KM_X_2KM_X_500M_10KM_X_4KM_X_1KM

Large School, Dense (5km x 2km x 500m - 10km x 4km x 1km)

Method Details

values

public static AddSpecificDimensionEnumerationsforSubsurfaceAreaSize[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static AddSpecificDimensionEnumerationsforSubsurfaceAreaSize valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Provide enumeration value

Returns:

integer value

getDescription

public String getDescription()

Provide enumeration description

Returns:

description

getEnumBitWidth

public static int getEnumBitWidth()

bit width for this enumeration

Returns:

number of bits wide

getEnumForValue

public static AddSpecificDimensionEnumerationsforSubsurfaceAreaSize getEnumForValue(int value)

Provide enumeration for a given value

Parameters:

value - integer value of interest

Returns:

enumeration corresponding to numeric value

setTRACE

public void setTRACE(boolean value)

Set tracing on/off for this object

Parameters:

value - whether tracing is on or off

getTRACE

public boolean getTRACE()

Whether tracing is on or off for this object

Returns:

whether tracing is on or off

marshal

public void marshal(DataOutputStream dos)
             throws IOException

Marshal value to DataOutputStream

Parameters:

dos - DataOutputStream for output

Throws:

IOException - input-output error

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

marshal

public void marshal(ByteBuffer byteBuffer)
             throws Exception

Marshal value to ByteBuffer

Parameters:

byteBuffer - ByteBuffer for output

Throws:

IOException - input-output error

Exception

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

unmarshalEnum

public static AddSpecificDimensionEnumerationsforSubsurfaceAreaSize unmarshalEnum(DataInputStream dis)
                                                                           throws Exception

Unmarshal value to DataInputStream

Parameters:

dis - DataInputStream for input

Returns:

enumeration of interest

Throws:

Exception - unmarshalling input-output error

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

unmarshalEnum

public static AddSpecificDimensionEnumerationsforSubsurfaceAreaSize unmarshalEnum(ByteBuffer byteBuffer)
                                                                           throws Exception

Unmarshal enumeration value to ByteBuffer

Parameters:

byteBuffer - ByteBuffer for input

Returns:

enumeration of interest

Throws:

Exception - unmarshalling input-output error

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

getMarshalledSize

public int getMarshalledSize()

Returns size of this serialized (marshalled) object in bytes

Returns:

serialized size in bytes

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

getName

public String getName()

Provide name

Returns:

name

toString

public String toString()

Provide simple identifier

Overrides:

toString in class Enum<AddSpecificDimensionEnumerationsforSubsurfaceAreaSize>

Returns:

class name, value and name