Enum Class PlatformSubsurfaceCategory

java.lang.Object

java.lang.Enum<PlatformSubsurfaceCategory>

edu.nps.moves.dis7.enumerations.PlatformSubsurfaceCategory

All Implemented Interfaces:

Category, Serializable, Comparable<PlatformSubsurfaceCategory>, Constable

public enum PlatformSubsurfaceCategory
extends Enum<PlatformSubsurfaceCategory>
implements Category

This enum type is generated from XML, UID 12, marshal size 8; PlatformSubsurfaceCategory has 20 enumerations total.

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
AGSS_AUXILIARY_SUBMARINE	AGSS (Auxiliary Submarine)
CIVILIAN_SEMI_SUBMERSIBLE_BOATS	Civilian Semi-Submersible Boats
CIVILIAN_SUBMARINES	Civilian Submarines
CIVILIAN_SUBMERSIBLES	Civilian Submersibles
OTHER	Other
SEMI_SUBMERSIBLE_BOATS	Semi-Submersible Boats
SS_CONVENTIONAL_ATTACK_TORPEDO_PATROL	SS (Conventional Attack - Torpedo, Patrol)
SSA_CONVENTIONAL_AUXILIARY	SSA (Conventional Auxiliary)
SSAN_NUCLEAR_AUXILIARY	SSAN (Nuclear Auxiliary)
SSB_SUBMARINE_BALLISTIC_BALLISTIC_MISSILE_SUBMARINE	SSB (Submarine Ballistic, Ballistic Missile Submarine)
SSBN_NUCLEAR_BALLISTIC_MISSILE	SSBN (Nuclear Ballistic Missile)
SSC_COASTAL_SUBMARINE_OVER_150_TONS	SSC (Coastal Submarine, over 150 tons)
SSG_CONVENTIONAL_GUIDED_MISSILE	SSG (Conventional Guided Missile)
SSGN_NUCLEAR_GUIDED_MISSILE	SSGN (Nuclear Guided Missile)
SSM_MIDGET_SUBMARINE_UNDER_150_TONS	SSM (Midget Submarine, under 150 tons)
SSN_NUCLEAR_ATTACK_TORPEDO	SSN (Nuclear Attack - Torpedo)
SSNR_SPECIAL_ATTACK_SUBMARINE	SSNR (Special Attack Submarine)
SSP_ATTACK_SUBMARINE_DIESEL_AIR_INDEPENDENT_PROPULSION	SSP (Attack Submarine - Diesel Air-Independent Propulsion)
SST_TRAINING_SUBMARINE	SST (Training Submarine)
UNMANNED_UNDERWATER_VEHICLE_UUV	Unmanned Underwater Vehicle (UUV)

Method Summary

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

OTHER

public static final PlatformSubsurfaceCategory OTHER

Other

SSBN_NUCLEAR_BALLISTIC_MISSILE

public static final PlatformSubsurfaceCategory SSBN_NUCLEAR_BALLISTIC_MISSILE

SSBN (Nuclear Ballistic Missile)

SSGN_NUCLEAR_GUIDED_MISSILE

public static final PlatformSubsurfaceCategory SSGN_NUCLEAR_GUIDED_MISSILE

SSGN (Nuclear Guided Missile)

SSN_NUCLEAR_ATTACK_TORPEDO

public static final PlatformSubsurfaceCategory SSN_NUCLEAR_ATTACK_TORPEDO

SSN (Nuclear Attack - Torpedo)

SSG_CONVENTIONAL_GUIDED_MISSILE

public static final PlatformSubsurfaceCategory SSG_CONVENTIONAL_GUIDED_MISSILE

SSG (Conventional Guided Missile)

SS_CONVENTIONAL_ATTACK_TORPEDO_PATROL

public static final PlatformSubsurfaceCategory SS_CONVENTIONAL_ATTACK_TORPEDO_PATROL

SS (Conventional Attack - Torpedo, Patrol)

SSAN_NUCLEAR_AUXILIARY

public static final PlatformSubsurfaceCategory SSAN_NUCLEAR_AUXILIARY

SSAN (Nuclear Auxiliary)

SSA_CONVENTIONAL_AUXILIARY

public static final PlatformSubsurfaceCategory SSA_CONVENTIONAL_AUXILIARY

SSA (Conventional Auxiliary)

UNMANNED_UNDERWATER_VEHICLE_UUV

public static final PlatformSubsurfaceCategory UNMANNED_UNDERWATER_VEHICLE_UUV

Unmanned Underwater Vehicle (UUV)

SSB_SUBMARINE_BALLISTIC_BALLISTIC_MISSILE_SUBMARINE

public static final PlatformSubsurfaceCategory SSB_SUBMARINE_BALLISTIC_BALLISTIC_MISSILE_SUBMARINE

SSB (Submarine Ballistic, Ballistic Missile Submarine)

SSC_COASTAL_SUBMARINE_OVER_150_TONS

public static final PlatformSubsurfaceCategory SSC_COASTAL_SUBMARINE_OVER_150_TONS

SSC (Coastal Submarine, over 150 tons)

SSP_ATTACK_SUBMARINE_DIESEL_AIR_INDEPENDENT_PROPULSION

public static final PlatformSubsurfaceCategory SSP_ATTACK_SUBMARINE_DIESEL_AIR_INDEPENDENT_PROPULSION

SSP (Attack Submarine - Diesel Air-Independent Propulsion)

SSM_MIDGET_SUBMARINE_UNDER_150_TONS

public static final PlatformSubsurfaceCategory SSM_MIDGET_SUBMARINE_UNDER_150_TONS

SSM (Midget Submarine, under 150 tons)

SSNR_SPECIAL_ATTACK_SUBMARINE

public static final PlatformSubsurfaceCategory SSNR_SPECIAL_ATTACK_SUBMARINE

SSNR (Special Attack Submarine)

SST_TRAINING_SUBMARINE

public static final PlatformSubsurfaceCategory SST_TRAINING_SUBMARINE

SST (Training Submarine)

AGSS_AUXILIARY_SUBMARINE

public static final PlatformSubsurfaceCategory AGSS_AUXILIARY_SUBMARINE

AGSS (Auxiliary Submarine)

SEMI_SUBMERSIBLE_BOATS

public static final PlatformSubsurfaceCategory SEMI_SUBMERSIBLE_BOATS

Semi-Submersible Boats

CIVILIAN_SUBMARINES

public static final PlatformSubsurfaceCategory CIVILIAN_SUBMARINES

Civilian Submarines

CIVILIAN_SUBMERSIBLES

public static final PlatformSubsurfaceCategory CIVILIAN_SUBMERSIBLES

Civilian Submersibles

CIVILIAN_SEMI_SUBMERSIBLE_BOATS

public static final PlatformSubsurfaceCategory CIVILIAN_SEMI_SUBMERSIBLE_BOATS

Civilian Semi-Submersible Boats

Method Details

values

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

Returns:

integer value

getDescription

public String getDescription()

Provide enumeration description

Specified by:

getDescription in interface Category

Returns:

description

getEnumBitWidth

public static int getEnumBitWidth()

bit width for this enumeration

Returns:

number of bits wide

getEnumForValue

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

Returns:

class name, value and name