Enum Class CIGIExtensionPacketID

java.lang.Object

java.lang.Enum<CIGIExtensionPacketID>

edu.nps.moves.dis7.enumerations.CIGIExtensionPacketID

All Implemented Interfaces:

Serializable, Comparable<CIGIExtensionPacketID>, Constable

public enum CIGIExtensionPacketID
extends Enum<CIGIExtensionPacketID>

This enum type is generated from XML, UID 780, marshal size 16; CIGIExtensionPacketID has 5 enumerations total. Registered extension packet IDs shall be in the range of 1000h - 7FFFh. If the extension capability includes both a request and response packet, it is recommended they be given sequential packet ID numbers. Submitters are welcome to request any ID within this range, but are encouraged to cluster packet IDs for similar capabilities if the next available sequential ID from the beginning of the range is not requested.

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
GLOBALREFFRAMEDEF_PACKET_ID	GlobalRefFrameDef Packet ID
IMAGE_CAPTURE_REQUEST_PACKET_ID	Image Capture Request packet ID
IMAGE_CAPTURE_RESPONSE_PACKET_ID	Image Capture Response packet ID
STATE_NOTIFICATION_REQUEST_PACKET_ID	State Notification Request Packet ID
STATE_NOTIFICATION_RESPONSE_PACKET_ID	State Notification Response Packet ID

Method Summary

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

IMAGE_CAPTURE_REQUEST_PACKET_ID

public static final CIGIExtensionPacketID IMAGE_CAPTURE_REQUEST_PACKET_ID

Image Capture Request packet ID

IMAGE_CAPTURE_RESPONSE_PACKET_ID

public static final CIGIExtensionPacketID IMAGE_CAPTURE_RESPONSE_PACKET_ID

Image Capture Response packet ID

STATE_NOTIFICATION_REQUEST_PACKET_ID

public static final CIGIExtensionPacketID STATE_NOTIFICATION_REQUEST_PACKET_ID

State Notification Request Packet ID

STATE_NOTIFICATION_RESPONSE_PACKET_ID

public static final CIGIExtensionPacketID STATE_NOTIFICATION_RESPONSE_PACKET_ID

State Notification Response Packet ID

GLOBALREFFRAMEDEF_PACKET_ID

public static final CIGIExtensionPacketID GLOBALREFFRAMEDEF_PACKET_ID

GlobalRefFrameDef Packet ID

Method Details

values

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

Returns:

ID number and name