mil.navy.nps.disEnumerations
Class ForceIDField

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

public class ForceIDField

extends java.lang.Object

Force ID Field -- This field shall distinguish the different teams or sides in a DIS exercise.

Version:

1.1

Author:

Ronan Fauglas, Don Brutzman

References:

DIS Data Dictionary: Force ID Field (local) Force ID 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 ForceIDField.NEUTRAL, 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:

ForceIDField.java (local)

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

Field Summary

static short	FRIENDLY (1) Friendly
static short	NEUTRAL (3) Neutral
static short	OPPOSING (2) Opposing
static short	OTHER (0) Other

Constructor Summary

ForceIDField()

Method Summary

static java.lang.String

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

Methods inherited from class java.lang.Object

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

Field Detail

OTHER

public static final short OTHER

(0) Other

See Also:

Constant Field Values

FRIENDLY

public static final short FRIENDLY

(1) Friendly

See Also:

Constant Field Values

OPPOSING

public static final short OPPOSING

(2) Opposing

See Also:

Constant Field Values

NEUTRAL

public static final short NEUTRAL

(3) Neutral

See Also:

Constant Field Values

Constructor Detail

ForceIDField

public ForceIDField()

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