mil.navy.nps.disEnumerations
Class AcknowledgeFlagField

java.lang.Object
  mil.navy.nps.disEnumerations.AcknowledgeFlagField

public class AcknowledgeFlagField

extends java.lang.Object

Acknowledge Flag Field -- This field shall indicate what type of message has been acknowledged. This field shall be represented byt a 16-bit enumeration (see Section 7 in EBV-DOC).

Version:

1.1

Author:

Ronan Fauglas, Don Brutzman

References:

DIS Data Dictionary: Acknowledge Flag Field (local) Acknowledge Flag Field (SISO)

JDBE:DIS Data Dictionary Version 1.0a (DIS-DD)

Perl script (converting html enumerations to java enumerations) convertJdbeDisEnumerationsToJava.pl (local) or http://web.3D.org/WorkingGroups/vrtp/mil/navy/nps/disEnumerations/convertJdbeDisEnumerationsToJava.pl

"Named Constants," The Java Programming Language, Gosling & Arnold.

Explanation:

This file has been automatically generated from a local copy of the DIS Data Dictionary at http://SISO.sc.ist.ucf.edu/dis/dis-dd/ html source file by convertJdbeDisEnumerationsToJava.pl (local) or http://www.web3D.org/WorkingGroups/vrtp/mil/navy/nps/disEnumerations/convertJdbeDisEnumerationsToJava.pl.

This is effectively a C-style enumeration. Java doesn't do enumerations like C, so you have to wrap a class around it. It's a bit more typing, but pretty simple-minded. Note that the variables are declared public. The default for access is package-wide, but these variables might need to be accessed from outside the package. Since all the variables are final (i.e. constant), nobody can change anything anyway, so this is no biggie.

To use these enumerations in your Java code, import the package first:

import mil.navy.nps.disEnumerations.*;

You access this via something like AcknowledgeFlagField.STOPFREEZE, i.e. combine the class name, a period, and a class variable (enumeration) name.

History:

21jan98 /Ronan Fauglas /New

30mar99 /Don Brutzman /Revised Javadoc, many more enumeration classes

Location:

AcknowledgeFlagField.java (local)

http://www.web3D.org/WorkingGroups/vrtp/mil/navy/nps/disEnumerations/AcknowledgeFlagField.java

Field Summary

static short	CREATEENTITY (1) Create Entity
static short	REMOVEENTITY (2) Remove entity
static short	STARTRESUME (3) Start/Resume
static short	STOPFREEZE (4) Stop/Freeze

Constructor Summary

AcknowledgeFlagField()

Method Summary

static java.lang.String

toString(int idNumber) Returns a string containing the enumeration name which corresponds to an enumeration value, as in AcknowledgeFlagField.toString (1) returns the string "CREATEENTITY"

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CREATEENTITY

public static final short CREATEENTITY

(1) Create Entity

See Also:

Constant Field Values

REMOVEENTITY

public static final short REMOVEENTITY

(2) Remove entity

See Also:

Constant Field Values

STARTRESUME

public static final short STARTRESUME

(3) Start/Resume

See Also:

Constant Field Values

STOPFREEZE

public static final short STOPFREEZE

(4) Stop/Freeze

See Also:

Constant Field Values

Constructor Detail

AcknowledgeFlagField

public AcknowledgeFlagField()

Method Detail

toString

public static java.lang.String toString(int idNumber)

Returns a string containing the enumeration name which corresponds to an enumeration value, as in AcknowledgeFlagField.toString (1) returns the string "CREATEENTITY"