mil.navy.nps.disEnumerations
Class EntitySmokeField

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

public class EntitySmokeField

extends java.lang.Object

Entity Smoke Field -- Describes status or location of smoke emanating from an entity

Version:

1.1

Author:

Ronan Fauglas, Don Brutzman

References:

DIS Data Dictionary: Entity Smoke Field (local) Entity Smoke 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 EntitySmokeField.ENTITYISEMITTINGENGINESMOKEANDSMOKEPLUMEISRSINGFROMTHEENTITY, 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:

EntitySmokeField.java (local)

http://www.web3D.org/WorkingGroups/vrtp/mil/navy/nps/disEnumerations/EntitySmokeField.java

Field Summary

static short	ENTITYISEMITTINGENGINESMOKE (2) Entity is emitting engine smoke
static short	ENTITYISEMITTINGENGINESMOKEANDSMOKEPLUMEISRSINGFROMTHEENTITY (3) Entity is emitting engine smoke and smoke plume is rsing from the entity
static short	NOTSMOKING (0) Not Smoking
static short	SMOKEPLUMEISRISINGFROMTHEENTITY (1) Smoke plume is rising from the entity

Constructor Summary

EntitySmokeField()

Method Summary

static java.lang.String

toString(int idNumber) Returns a string containing the enumeration name which corresponds to an enumeration value, as in EntitySmokeField.toString (0) returns the string "NOTSMOKING"

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NOTSMOKING

public static final short NOTSMOKING

(0) Not Smoking

See Also:

Constant Field Values

SMOKEPLUMEISRISINGFROMTHEENTITY

public static final short SMOKEPLUMEISRISINGFROMTHEENTITY

(1) Smoke plume is rising from the entity

See Also:

Constant Field Values

ENTITYISEMITTINGENGINESMOKE

public static final short ENTITYISEMITTINGENGINESMOKE

(2) Entity is emitting engine smoke

See Also:

Constant Field Values

ENTITYISEMITTINGENGINESMOKEANDSMOKEPLUMEISRSINGFROMTHEENTITY

public static final short ENTITYISEMITTINGENGINESMOKEANDSMOKEPLUMEISRSINGFROMTHEENTITY

(3) Entity is emitting engine smoke and smoke plume is rsing from the entity

See Also:

Constant Field Values

Constructor Detail

EntitySmokeField

public EntitySmokeField()

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