mil.navy.nps.dis
Class RadioEntityType

java.lang.Object
  mil.navy.nps.dis.PduElement
      mil.navy.nps.dis.RadioEntityType

All Implemented Interfaces:

java.lang.Cloneable, SerializationInterface

public class RadioEntityType

extends PduElement

implements SerializationInterface, java.lang.Cloneable

Entity Radio Type

Version:

1.0

Author:

Don McGregor (http://www.web3d.org/WorkingGroups/vrtp/dis-java-vrml/)

Location:

Web: http://www.web3d.org/WorkingGroups/vrtp/mil/navy/nps/dis/RadioEntityType.java

or locally: ~/mil/navy/nps/dis/RadioEntityType.java

Hierarchy Diagram:

Summary:

The type of radio in a DIS exercise shall be speciŽed by a Radio Entity Type record. This record shall specify the kind of entity, the domain, the country of design, and speciŽc information about the radio. The fields of this record are as follows: Entity Kind 8-bit enumeration Domain 8-bit enumeration Country 16-bit enumeration Category 8-bit enumeration Nomenclature Version 8-bit enumeration Nomenclature 16-bit enumeration

Explanation

The RadioEntityType class describes the location of an entity in 64-bit format. This crops up often enough to warrant its own class. (This is also known as "World Coordinates", as contrasted to "entity coordinates", which are 32-bit.

History:

10Aug00 /Dave Laflam /New

17DAug00 /Dave Laflam /Added toString method

References:

DIS Data Dictionary: Radio Entity Type record

DIS specification : IEEE 1278.1, 5.2.25 Radio Entity Type record

See Also:

PduElement, SerializationInterface, EntityCoordinate

Field Summary

protected UnsignedByte	category Fourth field of RadioEntityType This field shall specify the main category that describes the radio entity, and shall be represented by an 8-bit enumeration.
protected UnsignedShort	country Thrid field of RadioEntityType This field shall specify the country to which the design of the radio entity is attributed, and shall be represented by a 16-bit enumeration.
protected UnsignedByte	domain Second field of RadioEntityType This field shall specify the domain in which the radio entity operates, and shall be represented by an 8-bit enumeration.
protected UnsignedByte	entityKind First field of RadioEntityType This field shall identify the kind of entity described by the Radio Entity Type record, and shall be represented by an 8-bit enumeration.
protected UnsignedShort	nomenclature Sixth field of RadioEntityType This field shall specify the nomenclature for a particular communications device.
protected UnsignedByte	nomenclatureVersion Fifth field of RadioEntityType This field shall specify the speciŽc modification or individual unit type for a series and/or family of equipment.
int	sizeOf Constant value--size of a RadioEntityType record when written out; here :sizeOf = 64 bytes.

Constructor Summary

RadioEntityType()
Constructs an new RadioEntityType Object, centered.

RadioEntityType(UnsignedByte pEntityKind, UnsignedByte pDomain, UnsignedShort pCountry, UnsignedByte pCategory, UnsignedByte pNomenclatureVersion, UnsignedShort pNomenclature)
Constructs a new RadioEntityType Object whose coordinate values are passed in parameters.

Method Summary

java.lang.Object	clone() Makes deep copies of all the instance variables, so we don't have two objects pointing to the same data.
void	deSerialize(java.io.DataInputStream pInputStream) Reads an object in from DIS format.
UnsignedByte	getCategory() Gets the Category
UnsignedShort	getCountry() Gets the Country
UnsignedByte	getDomain() Gets the Domain
UnsignedByte	getEntityKind() Gets the EntityKind
UnsignedShort	getNomenclature() Gets the Nomenclature
UnsignedByte	getNomenclatureVersion() Gets the NomenclatureVersion
int	length() Returns the length of the object when serialized in a stream.
void	printValues(int indentLevel, java.io.PrintStream printStream) Prints the generated serialized object for debugging.
void	serialize(java.io.DataOutputStream outputStream) Writes an object out in DIS format.
void	setCategory(UnsignedByte pCategory) Sets the Category
void	setCountry(UnsignedShort pCountry) Sets the Country
void	setDomain(UnsignedByte pDomain) Sets the Domain
void	setEntityKind(UnsignedByte pEntityKind) Sets the EntityKind
void	setNomenclature(UnsignedShort pNomenclature) Sets the Nomenclature
void	setNomenclatureVersion(UnsignedByte pNomenclatureVersion) Sets the NomenclatureVersion
java.lang.String	toString() String toString Used for debuging

Methods inherited from class java.lang.Object

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

Field Detail

entityKind

protected UnsignedByte entityKind

First field of RadioEntityType This field shall identify the kind of entity described by the Radio Entity Type record, and shall be represented by an 8-bit enumeration. Values for this field are deŽned in Section 4 of EBV-DOC.

domain

protected UnsignedByte domain

Second field of RadioEntityType This field shall specify the domain in which the radio entity operates, and shall be represented by an 8-bit enumeration. Values for this field are defined in Section 4 of EBV-DOC.

country

protected UnsignedShort country

Thrid field of RadioEntityType This field shall specify the country to which the design of the radio entity is attributed, and shall be represented by a 16-bit enumeration. Values for this field are deŽned in Section 4 of EBV-DOC.

category

protected UnsignedByte category

Fourth field of RadioEntityType This field shall specify the main category that describes the radio entity, and shall be represented by an 8-bit enumeration. Values for this field are in Section 4 of EBV-DOC.

nomenclatureVersion

protected UnsignedByte nomenclatureVersion

Fifth field of RadioEntityType This field shall specify the speciŽc modification or individual unit type for a series and/or family of equipment. This field shall be represented by an 8-bit enumeration.

nomenclature

protected UnsignedShort nomenclature

Sixth field of RadioEntityType This field shall specify the nomenclature for a particular communications device. Nomenclatures are a combination of letters and/or numbers arranged in a speciŽc sequence to provide a short significant method of identifying specific equipment, series and/or families of equipment. This field shall be represented by a 16-bit enumeration.

sizeOf

public final int sizeOf

Constant value--size of a RadioEntityType record when written out; here :sizeOf = 64 bytes.

See Also:

Constant Field Values

Constructor Detail

RadioEntityType

public RadioEntityType()

Constructs an new RadioEntityType Object, centered.

RadioEntityType

public RadioEntityType(UnsignedByte pEntityKind,
                       UnsignedByte pDomain,
                       UnsignedShort pCountry,
                       UnsignedByte pCategory,
                       UnsignedByte pNomenclatureVersion,
                       UnsignedShort pNomenclature)

Constructs a new RadioEntityType Object whose coordinate values are passed in parameters.

Parameters:

pEntityKind - the first

pDomain - the second

pCountry - the third

pCategory - the fourth

pNomenclatureVersion - the fifth

pNomenclature - the sixth

Method Detail

clone

public java.lang.Object clone()

Description copied from class: PduElement

Makes deep copies of all the instance variables, so we don't have two objects pointing to the same data. The accessor methods make copies of the objects, rather than returning the objects themselves. The runtime provides the right object type with the call to super.clone(), and we cast it to our type. Subclasses should do the same thing, and all these ivars will be taken care of automatically.

Overrides:

clone in class PduElement

Returns:

a clone of this instance

See Also:

Object

serialize

public void serialize(java.io.DataOutputStream outputStream)

Description copied from interface: SerializationInterface

Writes an object out in DIS format.

Specified by:

serialize in interface SerializationInterface

Specified by:

serialize in class PduElement

Parameters:

outputStream - the stream to which this object is serialized

Throws:

java.lang.RuntimeException - when IO error occurs.

deSerialize

public void deSerialize(java.io.DataInputStream pInputStream)

Description copied from interface: SerializationInterface

Reads an object in from DIS format.

Specified by:

deSerialize in interface SerializationInterface

Specified by:

deSerialize in class PduElement

Parameters:

pInputStream - the stream from which this object is initialized

Throws:

java.lang.RuntimeException - when IO error occurs.

length

public int length()

Description copied from class: PduElement

Returns the length of the object when serialized in a stream.

Specified by:

length in class PduElement

Returns:

the length of the object when serialized in a stream

printValues

public void printValues(int indentLevel,
                        java.io.PrintStream printStream)

Description copied from class: PduElement

Prints the generated serialized object for debugging.

Specified by:

printValues in class PduElement

Parameters:

indentLevel - number of spaces to indent for visibility

getEntityKind

public UnsignedByte getEntityKind()

Gets the EntityKind

Returns:

entityKind

setEntityKind

public void setEntityKind(UnsignedByte pEntityKind)

Sets the EntityKind

Parameters:

pEntityKind - a EntityKind

getDomain

public UnsignedByte getDomain()

Gets the Domain

Returns:

domain

setDomain

public void setDomain(UnsignedByte pDomain)

Sets the Domain

Parameters:

pDomain - a Domain

getCountry

public UnsignedShort getCountry()

Gets the Country

Returns:

country

setCountry

public void setCountry(UnsignedShort pCountry)

Sets the Country

Parameters:

pCountry - a Country

getCategory

public UnsignedByte getCategory()

Gets the Category

Returns:

category

setCategory

public void setCategory(UnsignedByte pCategory)

Sets the Category

Parameters:

pCategory - a Category

getNomenclatureVersion

public UnsignedByte getNomenclatureVersion()

Gets the NomenclatureVersion

Returns:

nomenclatureVersion

setNomenclatureVersion

public void setNomenclatureVersion(UnsignedByte pNomenclatureVersion)

Sets the NomenclatureVersion

Parameters:

pNomenclatureVersion - a NomenclatureVersion

getNomenclature

public UnsignedShort getNomenclature()

Gets the Nomenclature

Returns:

nomenclature

setNomenclature

public void setNomenclature(UnsignedShort pNomenclature)

Sets the Nomenclature

Parameters:

pNomenclature - a Nomenclature

toString

public java.lang.String toString()

String toString Used for debuging