/* File: EntityDamageField.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 Damage Field -- Describes the damaged appearance of an entity *@version 1.1 *@author Ronan Fauglas *@author Don Brutzman * *
References: *
DIS Data Dictionary: Entity Damage Field (local) * Entity Damage 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 EntityDamageField.DESTROYED, 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: *
EntityDamageField.java (local) *
* http://www.web3D.org/WorkingGroups/vrtp/mil/navy/nps/disEnumerations/EntityDamageField.java * */ public class EntityDamageField extends Object { /** *(0) No Damage */ public static final short NODAMAGE = 0; /** *(1) Slight Damage */ public static final short SLIGHTDAMAGE = 1; /** *(2) Moderate Damage */ public static final short MODERATEDAMAGE = 2; /** *(3) Destroyed */ public static final short DESTROYED = 3; /** * Returns a string containing the enumeration name which corresponds to an enumeration value, * as in EntityDamageField.toString (0) returns the string "NODAMAGE" */ public static String toString(int idNumber) { switch (idNumber) { case 0: return "No Damage"; case 1: return "Slight Damage"; case 2: return "Moderate Damage"; case 3: return "Destroyed"; default : return ""; } }//end of toString }//End of class