Enum Class EntityAssociationGroupMemberType

java.lang.Object

java.lang.Enum<EntityAssociationGroupMemberType>

edu.nps.moves.dis7.enumerations.EntityAssociationGroupMemberType

All Implemented Interfaces:

Serializable, Comparable<EntityAssociationGroupMemberType>, Constable

public enum EntityAssociationGroupMemberType
extends Enum<EntityAssociationGroupMemberType>

This enum type is generated from XML, UID 321, marshal size 8; EntityAssociationGroupMemberType has 7 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
CONVOY_LEADER	Convoy Leader
CONVOY_MEMBER	Convoy Member
FORMATION_LEADER	Formation Leader
FORMATION_MEMBER	Formation Member
GROUP_LEADER	Group Leader
GROUP_MEMBER	Group Member
NOT_PART_OF_A_GROUP	Not Part of a Group

Method Summary

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

NOT_PART_OF_A_GROUP

public static final EntityAssociationGroupMemberType NOT_PART_OF_A_GROUP

Not Part of a Group

GROUP_LEADER

public static final EntityAssociationGroupMemberType GROUP_LEADER

Group Leader

GROUP_MEMBER

public static final EntityAssociationGroupMemberType GROUP_MEMBER

Group Member

FORMATION_LEADER

public static final EntityAssociationGroupMemberType FORMATION_LEADER

Formation Leader

FORMATION_MEMBER

public static final EntityAssociationGroupMemberType FORMATION_MEMBER

Formation Member

CONVOY_LEADER

public static final EntityAssociationGroupMemberType CONVOY_LEADER

Convoy Leader

CONVOY_MEMBER

public static final EntityAssociationGroupMemberType CONVOY_MEMBER

Convoy Member

Method Details

values

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

Returns:

class name, value and name