Enum Class PlatformSurfaceCategory

java.lang.Object

java.lang.Enum<PlatformSurfaceCategory>

edu.nps.moves.dis7.enumerations.PlatformSurfaceCategory

All Implemented Interfaces:

Category, Serializable, Comparable<PlatformSurfaceCategory>, Constable

public enum PlatformSurfaceCategory
extends Enum<PlatformSurfaceCategory>
implements Category

This enum type is generated from XML, UID 11, marshal size 8; PlatformSurfaceCategory has 48 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
ACKNOWLEDGE_RELIABLE	Amphibious Cargo Ship
ACTION_REQUEST_RELIABLE	Amphibious Transport Dock
ACTION_RESPONSE_RELIABLE	Ammunition Ship
AIR_CUSHION_SURFACE_EFFECT	Air Cushion/Surface Effect
AUXILIARY	Auxiliary
AUXILIARY_MERCHANT_MARINE	Auxiliary, Merchant Marine
CARRIER	Carrier
COMMAND_SHIP_CRUISER	Command Ship/Cruiser
COMMENT_RELIABLE	Coast Guard Cutters
CREATE_ENTITY_RELIABLE	Battleship
CRUISER_HELICOPTER_CARRIER	Cruiser/Helicopter Carrier
DATA_QUERY_RELIABLE	Combat Stores Ship
DATA_RELIABLE	Fast Combat Support Ship
DESTROYER_DD	Destroyer (DD)
DOCK_LANDING_SHIP	Dock Landing Ship
DRY_CARGO_SHIP_GROUP_2_MERCHANT_2	PlatformSurfaceDryCargoShipSubcategories
EVENT_REPORT_RELIABLE	Non-Combatant Ship
FISHING_VESSEL_2	PlatformSurfaceFishingVesselSubcategories
GUIDED_MISSILE_CRUISER	Guided Missile Cruiser
GUIDED_MISSILE_DESTROYER_DDG	Guided Missile Destroyer (DDG)
GUIDED_MISSILE_FRIGATE_FFG	Guided Missile Frigate (FFG)
HYDROFOIL	Hydrofoil
LANDING_CRAFT	Landing Craft
LIFE_SAVING_EQUIPMENT_2	LifeSavingEquipment
LIGHT_CARRIER	Light Carrier
LIGHT_PATROL_CRAFT	Light/Patrol Craft
LITTORAL_COMBAT_SHIPS_LCS	Littoral Combat Ships (LCS)
LIVE_ENTITY_DETONATION	Frigate (including Corvette)
MINE_COUNTERMEASURE_SHIP_CRAFT	Mine Countermeasure Ship/Craft
OFFSHORE_SUPPORT_VESSEL	Offshore Support Vessel
OTHER	Other
OTHER_VESSELS_2	PlatformSurfaceOtherVesselsSubcategories
PASSENGER_VESSEL_GROUP_1_MERCHANT_2	PlatformSurfacePassengerVesselSubcategories
PRIVATE_MOTORBOAT_2	PlatformSurfacePrivateMotorboatSubcategories
PRIVATE_SAILBOAT_2	PlatformSurfacePrivateSailboatSubcategories
RECORD_QUERY_RELIABLE	Inflatable Boat, Includes Rigid Inflatable Boats
RECORD_RELIABLE	Coast Guard Boats
REMOVE_ENTITY_RELIABLE	Heavy Cruiser
SEARCH_AND_RESCUE_VESSELS	Search and Rescue Vessels
SET_DATA_RELIABLE	Surveillance Towed Array Sonar System (SURTASS)
SET_RECORD_RELIABLE	Fast Attack Craft
START_RESUME_RELIABLE	Destroyer Tender
STOP_FREEZE_RELIABLE	Amphibious Assault Ship
SURVEILLANCE_SHIP	Surveillance Ship
TANK_LANDING_SHIP	Tank Landing Ship
TANKER_GROUP_3_MERCHANT_2	PlatformSurfaceTankerSubcategories
UNMANNED_SURFACE_VEHICLE_USV	Unmanned Surface Vehicle (USV)
UTILITY	Utility

Method Summary

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

Other

CARRIER

public static final PlatformSurfaceCategory CARRIER

Carrier

COMMAND_SHIP_CRUISER

public static final PlatformSurfaceCategory COMMAND_SHIP_CRUISER

Command Ship/Cruiser

GUIDED_MISSILE_CRUISER

public static final PlatformSurfaceCategory GUIDED_MISSILE_CRUISER

Guided Missile Cruiser

GUIDED_MISSILE_DESTROYER_DDG

public static final PlatformSurfaceCategory GUIDED_MISSILE_DESTROYER_DDG

Guided Missile Destroyer (DDG)

DESTROYER_DD

public static final PlatformSurfaceCategory DESTROYER_DD

Destroyer (DD)

GUIDED_MISSILE_FRIGATE_FFG

public static final PlatformSurfaceCategory GUIDED_MISSILE_FRIGATE_FFG

Guided Missile Frigate (FFG)

LIGHT_PATROL_CRAFT

public static final PlatformSurfaceCategory LIGHT_PATROL_CRAFT

Light/Patrol Craft

MINE_COUNTERMEASURE_SHIP_CRAFT

public static final PlatformSurfaceCategory MINE_COUNTERMEASURE_SHIP_CRAFT

Mine Countermeasure Ship/Craft

DOCK_LANDING_SHIP

public static final PlatformSurfaceCategory DOCK_LANDING_SHIP

Dock Landing Ship

TANK_LANDING_SHIP

public static final PlatformSurfaceCategory TANK_LANDING_SHIP

Tank Landing Ship

LANDING_CRAFT

public static final PlatformSurfaceCategory LANDING_CRAFT

Landing Craft

LIGHT_CARRIER

public static final PlatformSurfaceCategory LIGHT_CARRIER

Light Carrier

CRUISER_HELICOPTER_CARRIER

public static final PlatformSurfaceCategory CRUISER_HELICOPTER_CARRIER

Cruiser/Helicopter Carrier

HYDROFOIL

public static final PlatformSurfaceCategory HYDROFOIL

Hydrofoil

AIR_CUSHION_SURFACE_EFFECT

public static final PlatformSurfaceCategory AIR_CUSHION_SURFACE_EFFECT

Air Cushion/Surface Effect

AUXILIARY

public static final PlatformSurfaceCategory AUXILIARY

Auxiliary

AUXILIARY_MERCHANT_MARINE

public static final PlatformSurfaceCategory AUXILIARY_MERCHANT_MARINE

Auxiliary, Merchant Marine

UTILITY

public static final PlatformSurfaceCategory UTILITY

Utility

UNMANNED_SURFACE_VEHICLE_USV

public static final PlatformSurfaceCategory UNMANNED_SURFACE_VEHICLE_USV

Unmanned Surface Vehicle (USV)

LITTORAL_COMBAT_SHIPS_LCS

public static final PlatformSurfaceCategory LITTORAL_COMBAT_SHIPS_LCS

Littoral Combat Ships (LCS)

SURVEILLANCE_SHIP

public static final PlatformSurfaceCategory SURVEILLANCE_SHIP

Surveillance Ship

LIVE_ENTITY_DETONATION

public static final PlatformSurfaceCategory LIVE_ENTITY_DETONATION

Frigate (including Corvette)

CREATE_ENTITY_RELIABLE

public static final PlatformSurfaceCategory CREATE_ENTITY_RELIABLE

Battleship

REMOVE_ENTITY_RELIABLE

public static final PlatformSurfaceCategory REMOVE_ENTITY_RELIABLE

Heavy Cruiser

START_RESUME_RELIABLE

public static final PlatformSurfaceCategory START_RESUME_RELIABLE

Destroyer Tender

STOP_FREEZE_RELIABLE

public static final PlatformSurfaceCategory STOP_FREEZE_RELIABLE

Amphibious Assault Ship

ACKNOWLEDGE_RELIABLE

public static final PlatformSurfaceCategory ACKNOWLEDGE_RELIABLE

Amphibious Cargo Ship

ACTION_REQUEST_RELIABLE

public static final PlatformSurfaceCategory ACTION_REQUEST_RELIABLE

Amphibious Transport Dock

ACTION_RESPONSE_RELIABLE

public static final PlatformSurfaceCategory ACTION_RESPONSE_RELIABLE

Ammunition Ship

DATA_QUERY_RELIABLE

public static final PlatformSurfaceCategory DATA_QUERY_RELIABLE

Combat Stores Ship

SET_DATA_RELIABLE

public static final PlatformSurfaceCategory SET_DATA_RELIABLE

Surveillance Towed Array Sonar System (SURTASS)

DATA_RELIABLE

public static final PlatformSurfaceCategory DATA_RELIABLE

Fast Combat Support Ship

EVENT_REPORT_RELIABLE

public static final PlatformSurfaceCategory EVENT_REPORT_RELIABLE

Non-Combatant Ship

COMMENT_RELIABLE

public static final PlatformSurfaceCategory COMMENT_RELIABLE

Coast Guard Cutters

RECORD_RELIABLE

public static final PlatformSurfaceCategory RECORD_RELIABLE

Coast Guard Boats

SET_RECORD_RELIABLE

public static final PlatformSurfaceCategory SET_RECORD_RELIABLE

Fast Attack Craft

RECORD_QUERY_RELIABLE

public static final PlatformSurfaceCategory RECORD_QUERY_RELIABLE

Inflatable Boat, Includes Rigid Inflatable Boats

PASSENGER_VESSEL_GROUP_1_MERCHANT_2

public static final PlatformSurfaceCategory PASSENGER_VESSEL_GROUP_1_MERCHANT_2

PlatformSurfacePassengerVesselSubcategories

DRY_CARGO_SHIP_GROUP_2_MERCHANT_2

public static final PlatformSurfaceCategory DRY_CARGO_SHIP_GROUP_2_MERCHANT_2

PlatformSurfaceDryCargoShipSubcategories

TANKER_GROUP_3_MERCHANT_2

public static final PlatformSurfaceCategory TANKER_GROUP_3_MERCHANT_2

PlatformSurfaceTankerSubcategories

OFFSHORE_SUPPORT_VESSEL

public static final PlatformSurfaceCategory OFFSHORE_SUPPORT_VESSEL

Offshore Support Vessel

PRIVATE_MOTORBOAT_2

public static final PlatformSurfaceCategory PRIVATE_MOTORBOAT_2

PlatformSurfacePrivateMotorboatSubcategories

PRIVATE_SAILBOAT_2

public static final PlatformSurfaceCategory PRIVATE_SAILBOAT_2

PlatformSurfacePrivateSailboatSubcategories

FISHING_VESSEL_2

public static final PlatformSurfaceCategory FISHING_VESSEL_2

PlatformSurfaceFishingVesselSubcategories

OTHER_VESSELS_2

public static final PlatformSurfaceCategory OTHER_VESSELS_2

PlatformSurfaceOtherVesselsSubcategories

SEARCH_AND_RESCUE_VESSELS

public static final PlatformSurfaceCategory SEARCH_AND_RESCUE_VESSELS

Search and Rescue Vessels

LIFE_SAVING_EQUIPMENT_2

public static final PlatformSurfaceCategory LIFE_SAVING_EQUIPMENT_2

LifeSavingEquipment

Method Details

values

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

Returns:

class name, value and name