Enum Class IsPartOfNature

java.lang.Object

java.lang.Enum<IsPartOfNature>

edu.nps.moves.dis7.enumerations.IsPartOfNature

All Implemented Interfaces:

Serializable, Comparable<IsPartOfNature>, Constable

public enum IsPartOfNature
extends Enum<IsPartOfNature>

This enum type is generated from XML, UID 210, marshal size 16; IsPartOfNature has 11 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
COMPUTER_GENERATED_FORCES_CARRIED_AS_CARGO	Computer generated forces carried as cargo
EMITTER_MOUNTED_ON_HOST	Emitter mounted on host
ENTITY_STATIONED_AT_POSITION_WITH_RESPECT_TO_HOST	Entity stationed at position with respect to host
FUEL_CARRIED_AS_CARGO	Fuel carried as cargo
GUNMOUNT_ATTACHED_TO_HOST	Gunmount attached to host
HOST_FIREABLE_MUNITION	Host-fireable munition
MOBILE_COMMAND_AND_CONTROL_ENTITY_CARRIED_ABOARD_HOST	Mobile command and control entity carried aboard host
MUNITION_CARRIED_AS_CARGO	Munition carried as cargo
OTHER	Other
TEAM_MEMBER_IN_FORMATION_WITH	Team member in formation with
VEHICLE_CARRIED_AS_CARGO	Vehicle carried as cargo

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Provide enumeration description
static int	getEnumBitWidth()	bit width for this enumeration
static IsPartOfNature	getEnumForValue(int value)	Provide enumeration for a given value
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
String	getName()	Provide name
int	getValue()	Provide enumeration value
void	marshal(DataOutputStream dos)	Marshal value to DataOutputStream
void	marshal(ByteBuffer byteBuffer)	Marshal value to ByteBuffer
String	toString()	Provide simple identifier
static IsPartOfNature	unmarshalEnum(DataInputStream dis)	Unmarshal value to DataInputStream
static IsPartOfNature	unmarshalEnum(ByteBuffer byteBuffer)	Unmarshal enumeration value to ByteBuffer
static IsPartOfNature	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IsPartOfNature[]	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 IsPartOfNature OTHER

Other

HOST_FIREABLE_MUNITION

public static final IsPartOfNature HOST_FIREABLE_MUNITION

Host-fireable munition

MUNITION_CARRIED_AS_CARGO

public static final IsPartOfNature MUNITION_CARRIED_AS_CARGO

Munition carried as cargo

FUEL_CARRIED_AS_CARGO

public static final IsPartOfNature FUEL_CARRIED_AS_CARGO

Fuel carried as cargo

GUNMOUNT_ATTACHED_TO_HOST

public static final IsPartOfNature GUNMOUNT_ATTACHED_TO_HOST

Gunmount attached to host

COMPUTER_GENERATED_FORCES_CARRIED_AS_CARGO

public static final IsPartOfNature COMPUTER_GENERATED_FORCES_CARRIED_AS_CARGO

Computer generated forces carried as cargo

VEHICLE_CARRIED_AS_CARGO

public static final IsPartOfNature VEHICLE_CARRIED_AS_CARGO

Vehicle carried as cargo

EMITTER_MOUNTED_ON_HOST

public static final IsPartOfNature EMITTER_MOUNTED_ON_HOST

Emitter mounted on host

MOBILE_COMMAND_AND_CONTROL_ENTITY_CARRIED_ABOARD_HOST

public static final IsPartOfNature MOBILE_COMMAND_AND_CONTROL_ENTITY_CARRIED_ABOARD_HOST

Mobile command and control entity carried aboard host

ENTITY_STATIONED_AT_POSITION_WITH_RESPECT_TO_HOST

public static final IsPartOfNature ENTITY_STATIONED_AT_POSITION_WITH_RESPECT_TO_HOST

Entity stationed at position with respect to host

TEAM_MEMBER_IN_FORMATION_WITH

public static final IsPartOfNature TEAM_MEMBER_IN_FORMATION_WITH

Team member in formation with

Method Details

values

public static IsPartOfNature[] 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 IsPartOfNature 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 IsPartOfNature getEnumForValue(int value)

Provide enumeration for a given value

Parameters:

value - integer value of interest

Returns:

enumeration corresponding to numeric value

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 IsPartOfNature 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 IsPartOfNature 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<IsPartOfNature>

Returns:

ID number and name