Enum Class TransmitterAntennaPatternType

java.lang.Object

java.lang.Enum<TransmitterAntennaPatternType>

edu.nps.moves.dis7.enumerations.TransmitterAntennaPatternType

All Implemented Interfaces:

Serializable, Comparable<TransmitterAntennaPatternType>, Constable

public enum TransmitterAntennaPatternType
extends Enum<TransmitterAntennaPatternType>

This enum type is generated from XML, UID 167, marshal size 16; TransmitterAntennaPatternType has 6 enumerations total.

See Also:

• Java Tutorials: Enum Types
• Enum

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BEAM	Beam
BEAM_AND_TRANSMITTER_RADIATION_VOLUME	Beam and Transmitter Radiation Volume
ISOTROPIC_SPHERICAL_RADIATION_PATTERN	Isotropic (Spherical Radiation Pattern), Except for underwater acoustics, this was called 'omni-directional', 'omnidirectional' and 'omni directional' in DIS 7, RPR 2 and earlier versions of the DIS and RPR standards, but the intended meaning was a spherical radiation pattern.
OMNIDIRECTIONAL_TOROIDAL_RADIATION_PATTERN	Omnidirectional (Toroidal Radiation Pattern)
SPHERICAL_HARMONIC	Spherical harmonic
TRANSMITTER_RADIATION_VOLUME	Transmitter Radiation Volume

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Provide enumeration description
static int	getEnumBitWidth()	bit width for this enumeration
static TransmitterAntennaPatternType	getEnumForValue(int value)	Provide enumeration for a given value
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
String	getName()	Provide name
int	getValue()	Provide enumeration value
void	marshal(DataOutputStream dos)	Marshal value to DataOutputStream
void	marshal(ByteBuffer byteBuffer)	Marshal value to ByteBuffer
String	toString()	Provide simple identifier
static TransmitterAntennaPatternType	unmarshalEnum(DataInputStream dis)	Unmarshal value to DataInputStream
static TransmitterAntennaPatternType	unmarshalEnum(ByteBuffer byteBuffer)	Unmarshal enumeration value to ByteBuffer
static TransmitterAntennaPatternType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TransmitterAntennaPatternType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ISOTROPIC_SPHERICAL_RADIATION_PATTERN

public static final TransmitterAntennaPatternType ISOTROPIC_SPHERICAL_RADIATION_PATTERN

Isotropic (Spherical Radiation Pattern), Except for underwater acoustics, this was called 'omni-directional', 'omnidirectional' and 'omni directional' in DIS 7, RPR 2 and earlier versions of the DIS and RPR standards, but the intended meaning was a spherical radiation pattern.

BEAM

public static final TransmitterAntennaPatternType BEAM

Beam

SPHERICAL_HARMONIC

public static final TransmitterAntennaPatternType SPHERICAL_HARMONIC

Spherical harmonic

TRANSMITTER_RADIATION_VOLUME

public static final TransmitterAntennaPatternType TRANSMITTER_RADIATION_VOLUME

Transmitter Radiation Volume

BEAM_AND_TRANSMITTER_RADIATION_VOLUME

public static final TransmitterAntennaPatternType BEAM_AND_TRANSMITTER_RADIATION_VOLUME

Beam and Transmitter Radiation Volume

OMNIDIRECTIONAL_TOROIDAL_RADIATION_PATTERN

public static final TransmitterAntennaPatternType OMNIDIRECTIONAL_TOROIDAL_RADIATION_PATTERN

Omnidirectional (Toroidal Radiation Pattern)

Method Details

values

public static TransmitterAntennaPatternType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static TransmitterAntennaPatternType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Provide enumeration value

Returns:

integer value

getDescription

public String getDescription()

Provide enumeration description

Returns:

description

getEnumBitWidth

public static int getEnumBitWidth()

bit width for this enumeration

Returns:

number of bits wide

getEnumForValue

public static TransmitterAntennaPatternType getEnumForValue(int value)

Provide enumeration for a given value

Parameters:

value - integer value of interest

Returns:

enumeration corresponding to numeric value

marshal

public void marshal(DataOutputStream dos)
             throws IOException

Marshal value to DataOutputStream

Parameters:

dos - DataOutputStream for output

Throws:

IOException - input-output error

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

marshal

public void marshal(ByteBuffer byteBuffer)
             throws Exception

Marshal value to ByteBuffer

Parameters:

byteBuffer - ByteBuffer for output

Throws:

IOException - input-output error

Exception

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

unmarshalEnum

public static TransmitterAntennaPatternType unmarshalEnum(DataInputStream dis)
                                                   throws Exception

Unmarshal value to DataInputStream

Parameters:

dis - DataInputStream for input

Returns:

enumeration of interest

Throws:

Exception - unmarshalling input-output error

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

unmarshalEnum

public static TransmitterAntennaPatternType unmarshalEnum(ByteBuffer byteBuffer)
                                                   throws Exception

Unmarshal enumeration value to ByteBuffer

Parameters:

byteBuffer - ByteBuffer for input

Returns:

enumeration of interest

Throws:

Exception - unmarshalling input-output error

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

getMarshalledSize

public int getMarshalledSize()

Returns size of this serialized (marshalled) object in bytes

Returns:

serialized size in bytes

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

getName

public String getName()

Provide name

Returns:

name

toString

public String toString()

Provide simple identifier

Overrides:

toString in class Enum<TransmitterAntennaPatternType>

Returns:

ID number and name