mil.navy.nps.disEnumerations
Class EntityLightsField

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

public class EntityLightsField

extends java.lang.Object

Entity Lights Field -- Describes the status of lights found on various platforms

Version:

1.1

Author:

Ronan Fauglas, 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

Field Summary

static short	FROMATIONLIGHTSAREON (3) Fromation lights are on
static short	NAVIGATIONLIGHTSAREON (2) Navigation lights are on
static short	NONE (0) None
static short	RUNNINGLIGHTSAREON (1) Running lights are on
static short	UNUSED (4) Unused
static short	UNUSED2 (5) Unused
static short	UNUSED3 (6) Unused
static short	UNUSED4 (7) Unused

Constructor Summary

EntityLightsField()

Method Summary

static java.lang.String

toString(int idNumber) Returns a string containing the enumeration name which corresponds to an enumeration value, as in EntityLightsField.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

RUNNINGLIGHTSAREON

public static final short RUNNINGLIGHTSAREON

(1) Running lights are on

See Also:

Constant Field Values

NAVIGATIONLIGHTSAREON

public static final short NAVIGATIONLIGHTSAREON

(2) Navigation lights are on

See Also:

Constant Field Values

FROMATIONLIGHTSAREON

public static final short FROMATIONLIGHTSAREON

(3) Fromation lights are on

See Also:

Constant Field Values

UNUSED

public static final short UNUSED

(4) Unused

See Also:

Constant Field Values

UNUSED2

public static final short UNUSED2

(5) Unused

See Also:

Constant Field Values

UNUSED3

public static final short UNUSED3

(6) Unused

See Also:

Constant Field Values

UNUSED4

public static final short UNUSED4

(7) Unused

See Also:

Constant Field Values

Constructor Detail

EntityLightsField

public EntityLightsField()

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