mil.navy.nps.disEnumerations
Class EntityDamageField

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

public class EntityDamageField

extends java.lang.Object

Entity Damage Field -- Describes the damaged appearance of an entity

Version:

1.1

Author:

Ronan Fauglas, Don Brutzman

References:

DIS Data Dictionary: Entity Damage Field (local) Entity Damage 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 EntityDamageField.DESTROYED, 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:

EntityDamageField.java (local)

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

Field Summary

static short	DESTROYED (3) Destroyed
static short	MODERATEDAMAGE (2) Moderate Damage
static short	NODAMAGE (0) No Damage
static short	SLIGHTDAMAGE (1) Slight Damage

Constructor Summary

EntityDamageField()

Method Summary

static java.lang.String

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

Methods inherited from class java.lang.Object

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

Field Detail

NODAMAGE

public static final short NODAMAGE

(0) No Damage

See Also:

Constant Field Values

SLIGHTDAMAGE

public static final short SLIGHTDAMAGE

(1) Slight Damage

See Also:

Constant Field Values

MODERATEDAMAGE

public static final short MODERATEDAMAGE

(2) Moderate Damage

See Also:

Constant Field Values

DESTROYED

public static final short DESTROYED

(3) Destroyed

See Also:

Constant Field Values

Constructor Detail

EntityDamageField

public EntityDamageField()

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