mil.navy.nps.disEnumerations
Class ActionIDField

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

public class ActionIDField

extends java.lang.Object

Action ID Field -- This field shall specify the particular action that is requested by the simulation manager. This field shall be represented by a32-bit enumeration (see Section 7 in EBV-DOC).

Version:

1.1

Author:

Ronan Fauglas, Don Brutzman

References:

DIS Data Dictionary: Action ID Field (local) Action 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 ActionIDField.RECALLINITIALPARAMETERS, 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:

ActionIDField.java (local)

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

Field Summary

static int	ACCEPTSUBSCRIPTION (33) Accept Subscription
static int	CHANGEAGGREGATESTATE (36) Change aggregate state
static int	DATAQUERY (22) Data Query
static int	DISMOUNT (19) Dismount
static int	INFORMSMOFEVENTDAMAGE (4) Inform SM of event \"damage\"
static int	INFORMSMOFEVENTFIREDISABLED (6) Inform SM of event \"fire disabled\"
static int	INFORMSMOFEVENTKILLEDINACTION (3) Inform SM of event \"killed in action\"
static int	INFORMSMOFEVENTMOBILITYDISABLED (5) Inform SM of event \"mobility disabled\"
static int	INFORMSMOFEVENTRANOUTOFAMMUNITION (2) Inform SM of event \"ran out of ammunition\"
static int	INFORMSMOFEVENTRANOUTOFFUEL (7) Inform SM of event \"ran out of fuel\"
static int	INITIATEHITCHFOLLOW (16) Initiate hitch follow
static int	INITIATEHITCHLEAD (15) Initiate hitch lead
static int	INITIATESERVICESTATIONRESUPPLY (13) Initiate service station resupply
static int	INITIATETAILGATERESUPPLY (14) Initiate tailgate resupply
static int	INITIATETETHERFOLLOW (11) Initiate tether-follow
static int	INITIATETETHERLEAD (10) Initiate tether-lead
static int	LOCALSTORAGEOFTHEREQUESTEDINFORMATION (1) Local storage of the requested information
static int	LOCKSITECONFIGURATION (26) Lock Site Configuration
static int	MOUNT (18) Mount
static int	MOUNTINTENT (31) Mount Intent
static int	OTHER (0) Other
static int	QUERYSITECONFIGURATION (29) Query Site Configuration
static int	RECALLCHECKPOINTDATA (8) Recall checkpoint data
static int	RECALLINITIALPARAMETERS (9) Recall initial parameters
static int	RECONSTITUTE (25) Reconstitute
static int	SENDOBJECTSTATEDATA (24) Send Object State Data
static int	STARTDRC (20) Start DRC (Daily Readiness Check)
static int	STATUSREQUEST (23) Status Request
static int	STOPDRC (21) Stop DRC
static int	TELEPORTENTITY (35) Teleport entity
static int	TETHERINGINFORMATION (30) Tethering Information
static int	UNHITCH (17) Unhitch
static int	UNLOCKSITECONFIGURATION (27) Unlock Site Configuration
static int	UNSUBSCRIBE (34) Unsubscribe
static int	UNTETHER (12) Untether
static int	UPDATESITECONFIGURATION (28) Update Site Configuration

Constructor Summary

ActionIDField()

Method Summary

static java.lang.String

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

(0) Other

See Also:

Constant Field Values

LOCALSTORAGEOFTHEREQUESTEDINFORMATION

public static final int LOCALSTORAGEOFTHEREQUESTEDINFORMATION

(1) Local storage of the requested information

See Also:

Constant Field Values

INITIATETETHERLEAD

public static final int INITIATETETHERLEAD

(10) Initiate tether-lead

See Also:

Constant Field Values

INITIATETETHERFOLLOW

public static final int INITIATETETHERFOLLOW

(11) Initiate tether-follow

See Also:

Constant Field Values

UNTETHER

public static final int UNTETHER

(12) Untether

See Also:

Constant Field Values

INITIATESERVICESTATIONRESUPPLY

public static final int INITIATESERVICESTATIONRESUPPLY

(13) Initiate service station resupply

See Also:

Constant Field Values

INITIATETAILGATERESUPPLY

public static final int INITIATETAILGATERESUPPLY

(14) Initiate tailgate resupply

See Also:

Constant Field Values

INITIATEHITCHLEAD

public static final int INITIATEHITCHLEAD

(15) Initiate hitch lead

See Also:

Constant Field Values

INITIATEHITCHFOLLOW

public static final int INITIATEHITCHFOLLOW

(16) Initiate hitch follow

See Also:

Constant Field Values

UNHITCH

public static final int UNHITCH

(17) Unhitch

See Also:

Constant Field Values

MOUNT

public static final int MOUNT

(18) Mount

See Also:

Constant Field Values

DISMOUNT

public static final int DISMOUNT

(19) Dismount

See Also:

Constant Field Values

INFORMSMOFEVENTRANOUTOFAMMUNITION

public static final int INFORMSMOFEVENTRANOUTOFAMMUNITION

(2) Inform SM of event \"ran out of ammunition\"

See Also:

Constant Field Values

STARTDRC

public static final int STARTDRC

(20) Start DRC (Daily Readiness Check)

See Also:

Constant Field Values

STOPDRC

public static final int STOPDRC

(21) Stop DRC

See Also:

Constant Field Values

DATAQUERY

public static final int DATAQUERY

(22) Data Query

See Also:

Constant Field Values

STATUSREQUEST

public static final int STATUSREQUEST

(23) Status Request

See Also:

Constant Field Values

SENDOBJECTSTATEDATA

public static final int SENDOBJECTSTATEDATA

(24) Send Object State Data

See Also:

Constant Field Values

RECONSTITUTE

public static final int RECONSTITUTE

(25) Reconstitute

See Also:

Constant Field Values

LOCKSITECONFIGURATION

public static final int LOCKSITECONFIGURATION

(26) Lock Site Configuration

See Also:

Constant Field Values

UNLOCKSITECONFIGURATION

public static final int UNLOCKSITECONFIGURATION

(27) Unlock Site Configuration

See Also:

Constant Field Values

UPDATESITECONFIGURATION

public static final int UPDATESITECONFIGURATION

(28) Update Site Configuration

See Also:

Constant Field Values

QUERYSITECONFIGURATION

public static final int QUERYSITECONFIGURATION

(29) Query Site Configuration

See Also:

Constant Field Values

INFORMSMOFEVENTKILLEDINACTION

public static final int INFORMSMOFEVENTKILLEDINACTION

(3) Inform SM of event \"killed in action\"

See Also:

Constant Field Values

TETHERINGINFORMATION

public static final int TETHERINGINFORMATION

(30) Tethering Information

See Also:

Constant Field Values

MOUNTINTENT

public static final int MOUNTINTENT

(31) Mount Intent

See Also:

Constant Field Values

ACCEPTSUBSCRIPTION

public static final int ACCEPTSUBSCRIPTION

(33) Accept Subscription

See Also:

Constant Field Values

UNSUBSCRIBE

public static final int UNSUBSCRIBE

(34) Unsubscribe

See Also:

Constant Field Values

TELEPORTENTITY

public static final int TELEPORTENTITY

(35) Teleport entity

See Also:

Constant Field Values

CHANGEAGGREGATESTATE

public static final int CHANGEAGGREGATESTATE

(36) Change aggregate state

See Also:

Constant Field Values

INFORMSMOFEVENTDAMAGE

public static final int INFORMSMOFEVENTDAMAGE

(4) Inform SM of event \"damage\"

See Also:

Constant Field Values

INFORMSMOFEVENTMOBILITYDISABLED

public static final int INFORMSMOFEVENTMOBILITYDISABLED

(5) Inform SM of event \"mobility disabled\"

See Also:

Constant Field Values

INFORMSMOFEVENTFIREDISABLED

public static final int INFORMSMOFEVENTFIREDISABLED

(6) Inform SM of event \"fire disabled\"

See Also:

Constant Field Values

INFORMSMOFEVENTRANOUTOFFUEL

public static final int INFORMSMOFEVENTRANOUTOFFUEL

(7) Inform SM of event \"ran out of fuel\"

See Also:

Constant Field Values

RECALLCHECKPOINTDATA

public static final int RECALLCHECKPOINTDATA

(8) Recall checkpoint data

See Also:

Constant Field Values

RECALLINITIALPARAMETERS

public static final int RECALLINITIALPARAMETERS

(9) Recall initial parameters

See Also:

Constant Field Values

Constructor Detail

ActionIDField

public ActionIDField()

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