mil.navy.nps.disEnumerations
Class EntityFlamingEffectField

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

public class EntityFlamingEffectField
extends java.lang.Object

Entity Flaming Effect Field -- Describes whether flames are rising from an entity

Version:
1.1
Author:
Ronan Fauglas, Don Brutzman
References:
DIS Data Dictionary: Entity Flaming Effect Field (local) Entity Flaming Effect 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 EntityFlamingEffectField.FLAMESPRESENT, 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:
EntityFlamingEffectField.java (local)
http://www.web3D.org/WorkingGroups/vrtp/mil/navy/nps/disEnumerations/EntityFlamingEffectField.java

Field Summary
static short FLAMESPRESENT
          (1) Flames present
static short NONE
          (0) None
 
Constructor Summary
EntityFlamingEffectField()
           
 
Method Summary
static java.lang.String toString(int idNumber)
          Returns a string containing the enumeration name which corresponds to an enumeration value, as in EntityFlamingEffectField.toString (0) returns the string "NONE"
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NONE

public static final short NONE
(0) None

See Also:
Constant Field Values

FLAMESPRESENT

public static final short FLAMESPRESENT
(1) Flames present

See Also:
Constant Field Values
Constructor Detail

EntityFlamingEffectField

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