mil.navy.nps.disEnumerations
Class ReasonField

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

public class ReasonField

extends java.lang.Object

Reason Field -- This field shall specify the reason that an entity or exercies was stopped/frozen. This field shall be represented by an 8-bit enumberation (see Section 7 in EBV-DOC)

Version:

1.1

Author:

Ronan Fauglas, Don Brutzman

References:

DIS Data Dictionary: Reason Field (local) Reason 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 ReasonField.ABORTTRAININGRETURNTOTACTICALOPERATIONS, 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:

ReasonField.java (local)

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

Field Summary

static short	ABORTTRAININGRETURNTOTACTICALOPERATIONS (8) Abort Training Return to Tactical Operations
static short	ENTITYRECONSTITUTION (5) Entity Reconstitution
static short	OTHER (0) Other
static short	RECESS (1) Recess
static short	SECURITYVIOLATION (4) Security Violation
static short	STOPFORRESET (6) Stop for reset
static short	STOPFORRESTART (7) Stop for restart
static short	SYSTEMFAILURE (3) System Failure
static short	TERMINATION (2) Termination

Constructor Summary

ReasonField()

Method Summary

static java.lang.String

toString(int idNumber) Returns a string containing the enumeration name which corresponds to an enumeration value, as in ReasonField.toString (0) returns the string "OTHER"

Methods inherited from class java.lang.Object

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

Field Detail

OTHER

public static final short OTHER

(0) Other

See Also:

Constant Field Values

RECESS

public static final short RECESS

(1) Recess

See Also:

Constant Field Values

TERMINATION

public static final short TERMINATION

(2) Termination

See Also:

Constant Field Values

SYSTEMFAILURE

public static final short SYSTEMFAILURE

(3) System Failure

See Also:

Constant Field Values

SECURITYVIOLATION

public static final short SECURITYVIOLATION

(4) Security Violation

See Also:

Constant Field Values

ENTITYRECONSTITUTION

public static final short ENTITYRECONSTITUTION

(5) Entity Reconstitution

See Also:

Constant Field Values

STOPFORRESET

public static final short STOPFORRESET

(6) Stop for reset

See Also:

Constant Field Values

STOPFORRESTART

public static final short STOPFORRESTART

(7) Stop for restart

See Also:

Constant Field Values

ABORTTRAININGRETURNTOTACTICALOPERATIONS

public static final short ABORTTRAININGRETURNTOTACTICALOPERATIONS

(8) Abort Training Return to Tactical Operations

See Also:

Constant Field Values

Constructor Detail

ReasonField

public ReasonField()

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