mil.navy.nps.disEnumerations
Class ReceiverStatefield

java.lang.Object
  extended bymil.navy.nps.disEnumerations.ReceiverStatefield

public class ReceiverStatefield
extends java.lang.Object

Receiver State field -- This field shall indicate the state of the receiver, which shall either be idle or active. This field shall be represented by a 16-bit enumeration (see Section 9 in EBV-DOC).

Version:
1.1
Author:
Ronan Fauglas, Don Brutzman
References:
DIS Data Dictionary: Receiver State field (local) Receiver State 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 ReceiverStatefield.ONANDRECEIVING, 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:
ReceiverStatefield.java (local)
http://www.web3D.org/WorkingGroups/vrtp/mil/navy/nps/disEnumerations/ReceiverStatefield.java

Field Summary
static short OFF
          (0) Off
static short ONANDRECEIVING
          (2) On and receiving
static short ONBUTNOTRECEIVING
          (1) On but not receiving
 
Constructor Summary
ReceiverStatefield()
           
 
Method Summary
static java.lang.String toString(int idNumber)
          Returns a string containing the enumeration name which corresponds to an enumeration value, as in ReceiverStatefield.toString (0) returns the string "OFF"
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OFF

public static final short OFF
(0) Off

See Also:
Constant Field Values

ONBUTNOTRECEIVING

public static final short ONBUTNOTRECEIVING
(1) On but not receiving

See Also:
Constant Field Values

ONANDRECEIVING

public static final short ONANDRECEIVING
(2) On and receiving

See Also:
Constant Field Values
Constructor Detail

ReceiverStatefield

public ReceiverStatefield()
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 ReceiverStatefield.toString (0) returns the string "OFF"