mil.navy.nps.disEnumerations
Class AntennaPatternTypefield

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

public class AntennaPatternTypefield

extends java.lang.Object

Antenna Pattern Type field -- This field shall specify the type of representation used for the radiation pattern from the antenna. The value of this field shall determine the interpretation of the Antenna Pattern Parameter field. This field shall be represented by a 16-bit enumeration (see Section 9 in EBV-DOC).

Version:

1.1

Author:

Ronan Fauglas, Don Brutzman

References:

DIS Data Dictionary: Antenna Pattern Type field (local) Antenna Pattern Type 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 AntennaPatternTypefield.SPHERICALHARMONIC, 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:

AntennaPatternTypefield.java (local)

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

Field Summary

static short	BEAM (1) Beam
static short	OMNIDIRECTIONAL (0) Omni-directional
static short	SPHERICALHARMONIC (2) Spherical harmonic

Constructor Summary

AntennaPatternTypefield()

Method Summary

static java.lang.String

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

Methods inherited from class java.lang.Object

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

Field Detail

OMNIDIRECTIONAL

public static final short OMNIDIRECTIONAL

(0) Omni-directional

See Also:

Constant Field Values

BEAM

public static final short BEAM

(1) Beam

See Also:

Constant Field Values

SPHERICALHARMONIC

public static final short SPHERICALHARMONIC

(2) Spherical harmonic

See Also:

Constant Field Values

Constructor Detail

AntennaPatternTypefield

public AntennaPatternTypefield()

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