mil.navy.nps.disEnumerations
Class TransmitStatefield

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

public class TransmitStatefield

extends java.lang.Object

Transmit State field -- This field shall specify whether a radio is off, powered but not transmitting, or powered and transmitting. This field shall be represented by an 8-bit enumberation. (see Section 9 in EBV-DOC).

Version:

1.1

Author:

Ronan Fauglas, Don Brutzman

References:

DIS Data Dictionary: Transmit State field (local) Transmit 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 TransmitStatefield.ONANDTRANSMITTING, 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:

TransmitStatefield.java (local)

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

Field Summary

static short	OFF (0) Off
static short	ONANDTRANSMITTING (2) On and transmitting
static short	ONBUTNOTTRANSMITTING (1) On but not transmitting

Constructor Summary

TransmitStatefield()

Method Summary

static java.lang.String

toString(int idNumber) Returns a string containing the enumeration name which corresponds to an enumeration value, as in TransmitStatefield.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

ONBUTNOTTRANSMITTING

public static final short ONBUTNOTTRANSMITTING

(1) On but not transmitting

See Also:

Constant Field Values

ONANDTRANSMITTING

public static final short ONANDTRANSMITTING

(2) On and transmitting

See Also:

Constant Field Values

Constructor Detail

TransmitStatefield

public TransmitStatefield()

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