mil.navy.nps.disEnumerations
Class EntityHatchStateField

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

public class EntityHatchStateField

extends java.lang.Object

Entity Hatch State Field -- Describes the state of the hatch

Version:

1.1

Author:

Ronan Fauglas, Don Brutzman

References:

DIS Data Dictionary: Entity Hatch State Field (local) Entity Hatch State 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 EntityHatchStateField.UNUSED2, 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:

EntityHatchStateField.java (local)

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

Field Summary

static short	NOTAPPLICABLE (0) Not applicable
static short	PRIMARYHATCHISCLOSED (1) Primary hatch is closed
static short	PRIMARYHATCHISOPEN (4) Primary hatch is open
static short	PRIMARYHATCHISOPENANDPERSONISVISIBLE (5) Primary hatch is open and person is visible
static short	PRIMARYHATCHISPOPPED (2) Primary hatch is popped
static short	PRIMARYHATCHISPOPPEDANDAPERSONISVISIBLEUNDERHATCH (3) Primary hatch is popped and a person is visible under hatch
static short	UNUSED (6) Unused
static short	UNUSED2 (7) Unused

Constructor Summary

EntityHatchStateField()

Method Summary

static java.lang.String

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

Methods inherited from class java.lang.Object

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

Field Detail

NOTAPPLICABLE

public static final short NOTAPPLICABLE

(0) Not applicable

See Also:

Constant Field Values

PRIMARYHATCHISCLOSED

public static final short PRIMARYHATCHISCLOSED

(1) Primary hatch is closed

See Also:

Constant Field Values

PRIMARYHATCHISPOPPED

public static final short PRIMARYHATCHISPOPPED

(2) Primary hatch is popped

See Also:

Constant Field Values

PRIMARYHATCHISPOPPEDANDAPERSONISVISIBLEUNDERHATCH

public static final short PRIMARYHATCHISPOPPEDANDAPERSONISVISIBLEUNDERHATCH

(3) Primary hatch is popped and a person is visible under hatch

See Also:

Constant Field Values

PRIMARYHATCHISOPEN

public static final short PRIMARYHATCHISOPEN

(4) Primary hatch is open

See Also:

Constant Field Values

PRIMARYHATCHISOPENANDPERSONISVISIBLE

public static final short PRIMARYHATCHISOPENANDPERSONISVISIBLE

(5) Primary hatch is open and person is visible

See Also:

Constant Field Values

UNUSED

public static final short UNUSED

(6) Unused

See Also:

Constant Field Values

UNUSED2

public static final short UNUSED2

(7) Unused

See Also:

Constant Field Values

Constructor Detail

EntityHatchStateField

public EntityHatchStateField()

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