mil.navy.nps.disEnumerations
Class EntityTrailingEffectField

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

public class EntityTrailingEffectField

extends java.lang.Object

Entity Trailing Effect Field -- Describes the size of trailing effects from an entity. Trailing effects include dust clouds for land platforms, wakes for surface platforms, rocket flames for guided munitions, contrails and ionization trails for air paltforms, etc.

Version:

1.1

Author:

Ronan Fauglas, Don Brutzman

References:

DIS Data Dictionary: Entity Trailing Effect Field (local) Entity Trailing Effect 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 EntityTrailingEffectField.LARGE, 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:

EntityTrailingEffectField.java (local)

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

Field Summary

static short	LARGE (3) Large
static short	MEDIUM (2) Medium
static short	NONE (0) None
static short	SMALL (1) Small

Constructor Summary

EntityTrailingEffectField()

Method Summary

static java.lang.String

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

SMALL

public static final short SMALL

(1) Small

See Also:

Constant Field Values

MEDIUM

public static final short MEDIUM

(2) Medium

See Also:

Constant Field Values

LARGE

public static final short LARGE

(3) Large

See Also:

Constant Field Values

Constructor Detail

EntityTrailingEffectField

public EntityTrailingEffectField()

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