Enum Class PlatformSurfaceSupportVesselSubcategories

java.lang.Object

java.lang.Enum<PlatformSurfaceSupportVesselSubcategories>

edu.nps.moves.dis7.enumerations.PlatformSurfaceSupportVesselSubcategories

All Implemented Interfaces:

SubCategory, Serializable, Comparable<PlatformSurfaceSupportVesselSubcategories>, Constable

public enum PlatformSurfaceSupportVesselSubcategories
extends Enum<PlatformSurfaceSupportVesselSubcategories>
implements SubCategory

This enum type is generated from XML, UID 444, marshal size 8; PlatformSurfaceSupportVesselSubcategories has 9 enumerations total. Subcategories for Surface Platform Category 83

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
ANCHOR_HANDLING_TUG_SUPPLY_VESSEL_AHTS	Anchor Handling Tug Supply Vessel (AHTS)
DIVE_SUPPORT_VESSEL	Dive Support Vessel
EMERGENCY_RESPONSE_AND_RESCUE_VESSEL_ERRV	Emergency Response and Rescue Vessel (ERRV)
FIREBOAT	Fireboat
OFFSHORE_CONSTRUCTION_VESSEL_OCV	Offshore Construction Vessel (OCV)
PLATFORM_SUPPLY_VESSEL	Platform Supply Vessel
TENDER_VESSEL	Tender Vessel
TUGBOAT	Tugboat
WELL_STIMULATION_VESSEL_WSV	Well Stimulation Vessel (WSV)

Method Summary

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

PLATFORM_SUPPLY_VESSEL

public static final PlatformSurfaceSupportVesselSubcategories PLATFORM_SUPPLY_VESSEL

Platform Supply Vessel

TENDER_VESSEL

public static final PlatformSurfaceSupportVesselSubcategories TENDER_VESSEL

Tender Vessel

TUGBOAT

public static final PlatformSurfaceSupportVesselSubcategories TUGBOAT

Tugboat

DIVE_SUPPORT_VESSEL

public static final PlatformSurfaceSupportVesselSubcategories DIVE_SUPPORT_VESSEL

Dive Support Vessel

FIREBOAT

public static final PlatformSurfaceSupportVesselSubcategories FIREBOAT

Fireboat

WELL_STIMULATION_VESSEL_WSV

public static final PlatformSurfaceSupportVesselSubcategories WELL_STIMULATION_VESSEL_WSV

Well Stimulation Vessel (WSV)

ANCHOR_HANDLING_TUG_SUPPLY_VESSEL_AHTS

public static final PlatformSurfaceSupportVesselSubcategories ANCHOR_HANDLING_TUG_SUPPLY_VESSEL_AHTS

Anchor Handling Tug Supply Vessel (AHTS)

OFFSHORE_CONSTRUCTION_VESSEL_OCV

public static final PlatformSurfaceSupportVesselSubcategories OFFSHORE_CONSTRUCTION_VESSEL_OCV

Offshore Construction Vessel (OCV)

EMERGENCY_RESPONSE_AND_RESCUE_VESSEL_ERRV

public static final PlatformSurfaceSupportVesselSubcategories EMERGENCY_RESPONSE_AND_RESCUE_VESSEL_ERRV

Emergency Response and Rescue Vessel (ERRV)

Method Details

values

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

Returns:

class name, value and name