Enum Class PlatformSurfaceOtherVesselsSubcategories

java.lang.Object

java.lang.Enum<PlatformSurfaceOtherVesselsSubcategories>

edu.nps.moves.dis7.enumerations.PlatformSurfaceOtherVesselsSubcategories

All Implemented Interfaces:

SubCategory, Serializable, Comparable<PlatformSurfaceOtherVesselsSubcategories>, Constable

public enum PlatformSurfaceOtherVesselsSubcategories
extends Enum<PlatformSurfaceOtherVesselsSubcategories>
implements SubCategory

This enum type is generated from XML, UID 448, marshal size 8; PlatformSurfaceOtherVesselsSubcategories has 13 enumerations total. Subcategories for Surface Platform Category 87.

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
CABLE_LAYER_VESSEL	Cable Layer Vessel
CATAMARAN	Catamaran
DREDGER_VESSEL	Dredger Vessel
GO_FAST_BOAT	Go-Fast Boat
HYDROFOIL_VESSEL	Hydrofoil Vessel
JUNK_DHOW_VESSEL	Junk/Dhow Vessel
LAW_ENFORCEMENT_VESSEL	Law Enforcement Vessel
LIGHTSHIP	Lightship
PERSONAL_WATER_CRAFT	Personal Water Craft
PILOT_VESSEL	Pilot Vessel
PONTOON	Pontoon
REFUGEE_RAFT	Refugee Raft
RESEARCH_VESSEL	Research Vessel

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Provide enumeration description
static int	getEnumBitWidth()	bit width for this enumeration
static PlatformSurfaceOtherVesselsSubcategories	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 PlatformSurfaceOtherVesselsSubcategories	unmarshalEnum(DataInputStream dis)	Unmarshal value to DataInputStream
static PlatformSurfaceOtherVesselsSubcategories	unmarshalEnum(ByteBuffer byteBuffer)	Unmarshal enumeration value to ByteBuffer
static PlatformSurfaceOtherVesselsSubcategories	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PlatformSurfaceOtherVesselsSubcategories[]	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

GO_FAST_BOAT

public static final PlatformSurfaceOtherVesselsSubcategories GO_FAST_BOAT

Go-Fast Boat

RESEARCH_VESSEL

public static final PlatformSurfaceOtherVesselsSubcategories RESEARCH_VESSEL

Research Vessel

HYDROFOIL_VESSEL

public static final PlatformSurfaceOtherVesselsSubcategories HYDROFOIL_VESSEL

Hydrofoil Vessel

CABLE_LAYER_VESSEL

public static final PlatformSurfaceOtherVesselsSubcategories CABLE_LAYER_VESSEL

Cable Layer Vessel

DREDGER_VESSEL

public static final PlatformSurfaceOtherVesselsSubcategories DREDGER_VESSEL

Dredger Vessel

JUNK_DHOW_VESSEL

public static final PlatformSurfaceOtherVesselsSubcategories JUNK_DHOW_VESSEL

Junk/Dhow Vessel

CATAMARAN

public static final PlatformSurfaceOtherVesselsSubcategories CATAMARAN

Catamaran

PONTOON

public static final PlatformSurfaceOtherVesselsSubcategories PONTOON

Pontoon

PERSONAL_WATER_CRAFT

public static final PlatformSurfaceOtherVesselsSubcategories PERSONAL_WATER_CRAFT

Personal Water Craft

REFUGEE_RAFT

public static final PlatformSurfaceOtherVesselsSubcategories REFUGEE_RAFT

Refugee Raft

LIGHTSHIP

public static final PlatformSurfaceOtherVesselsSubcategories LIGHTSHIP

Lightship

LAW_ENFORCEMENT_VESSEL

public static final PlatformSurfaceOtherVesselsSubcategories LAW_ENFORCEMENT_VESSEL

Law Enforcement Vessel

PILOT_VESSEL

public static final PlatformSurfaceOtherVesselsSubcategories PILOT_VESSEL

Pilot Vessel

Method Details

values

public static PlatformSurfaceOtherVesselsSubcategories[] 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 PlatformSurfaceOtherVesselsSubcategories 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

Specified by:

getValue in interface SubCategory

Returns:

integer value

getDescription

public String getDescription()

Provide enumeration description

Specified by:

getDescription in interface SubCategory

Returns:

description

getEnumBitWidth

public static int getEnumBitWidth()

bit width for this enumeration

Returns:

number of bits wide

getEnumForValue

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

Returns:

class name, value and name