/*
File: EntityLightsField.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 Lights Field -- Describes the status of lights found on various platforms
*@version 1.1
*@author Ronan Fauglas
*@author Don Brutzman
*
*
References:
* DIS Data Dictionary: Entity Lights Field (local)
* Entity Lights 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 EntityLightsField.UNUSED4
, 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:
*EntityLightsField.java (local)
*
* http://www.web3D.org/WorkingGroups/vrtp/mil/navy/nps/disEnumerations/EntityLightsField.java
*
*/
public class EntityLightsField extends Object
{
/**
*(0) None
*/
public static final short NONE = 0;
/**
*(1) Running lights are on
*/
public static final short RUNNINGLIGHTSAREON = 1;
/**
*(2) Navigation lights are on
*/
public static final short NAVIGATIONLIGHTSAREON = 2;
/**
*(3) Fromation lights are on
*/
public static final short FROMATIONLIGHTSAREON = 3;
/**
*(4) Unused
*/
public static final short UNUSED = 4;
/**
*(5) Unused
*/
public static final short UNUSED2 = 5;
/**
*(6) Unused
*/
public static final short UNUSED3 = 6;
/**
*(7) Unused
*/
public static final short UNUSED4 = 7;
/**
* Returns a string containing the enumeration name which corresponds to an enumeration value,
* as in EntityLightsField.toString (0)
returns the string "NONE
"
*/
public static String toString(int idNumber)
{
switch (idNumber) {
case 0: return "None";
case 1: return "Running lights are on";
case 2: return "Navigation lights are on";
case 3: return "Fromation lights are on";
case 4: return "Unused";
case 5: return "Unused";
case 6: return "Unused";
case 7: return "Unused";
default : return "";
}
}//end of toString
}//End of class