/* File: EntityHatchStateField.java CVS Info: $Id$ Compiler: jdk 1.2.2 */ package mil.navy.nps.disEnumerations; import mil.navy.nps.dis.*; import mil.navy.nps.util.*; /** * Entity Hatch State Field -- Describes the state of the hatch *@version 1.1 *@author Ronan Fauglas *@author Don Brutzman * *
References: *
DIS Data Dictionary: Entity Hatch State Field (local) * Entity Hatch 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 EntityHatchStateField.UNUSED2, 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: *
EntityHatchStateField.java (local) *
* http://www.web3D.org/WorkingGroups/vrtp/mil/navy/nps/disEnumerations/EntityHatchStateField.java * */ public class EntityHatchStateField extends Object { /** *(0) Not applicable */ public static final short NOTAPPLICABLE = 0; /** *(1) Primary hatch is closed */ public static final short PRIMARYHATCHISCLOSED = 1; /** *(2) Primary hatch is popped */ public static final short PRIMARYHATCHISPOPPED = 2; /** *(3) Primary hatch is popped and a person is visible under hatch */ public static final short PRIMARYHATCHISPOPPEDANDAPERSONISVISIBLEUNDERHATCH = 3; /** *(4) Primary hatch is open */ public static final short PRIMARYHATCHISOPEN = 4; /** *(5) Primary hatch is open and person is visible */ public static final short PRIMARYHATCHISOPENANDPERSONISVISIBLE = 5; /** *(6) Unused */ public static final short UNUSED = 6; /** *(7) Unused */ public static final short UNUSED2 = 7; /** * Returns a string containing the enumeration name which corresponds to an enumeration value, * as in EntityHatchStateField.toString (0) returns the string "NOTAPPLICABLE" */ public static String toString(int idNumber) { switch (idNumber) { case 0: return "Not applicable"; case 1: return "Primary hatch is closed"; case 2: return "Primary hatch is popped"; case 3: return "Primary hatch is popped and a person is visible under hatch"; case 4: return "Primary hatch is open"; case 5: return "Primary hatch is open and person is visible"; case 6: return "Unused"; case 7: return "Unused"; default : return ""; } }//end of toString }//End of class