mil.navy.nps.dis
Class ModulationType

java.lang.Object
  extended bymil.navy.nps.dis.PduElement
      extended bymil.navy.nps.dis.ModulationType
All Implemented Interfaces:
java.lang.Cloneable, SerializationInterface

public class ModulationType
extends PduElement
implements SerializationInterface, java.lang.Cloneable

Entity location in world coordinates.

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/ModulationType.java
or locally: ~/mil/navy/nps/dis/ModulationType.java
Hierarchy Diagram:
Summary:
Information about the type of modulation used for radio transmission shall be represented by a Modulation Type record.
Explanation
This record uniquely identifies the various sets of signal parameters (i.e., the modulation type) that are used to determine whether two radios may interoperate. The modulation is characterized in a generic fashion by the Spread Spectrum, Major Modulation Type, and Detail Țelds. The classes of interoperable modulation types are enumerated by the System field. This record shall specify the spread-spectrum usage,major modulation type, detailed information, and system compatibility.

History:
3AUG00 /Dave Laflam /New
17DAug00 /Dave Laflam /Added toString method, changed system varible to system
References:
DIS Data Dictionary: Modulation Type Record
DIS specification : IEEE 1278.1, 5.2.23 Modulation Type record pg 68
See Also:
PduElement, SerializationInterface, EntityCoordinate

Field Summary
protected  UnsignedShort detail
          Detail : This field shall provide certain detailed information depending upon the major modulation type.
protected  UnsignedShort major
          Major :Major Modulation Type.
 int sizeOf
          Constant value--size of a World Coordinate record when written out; here :sizeOf = 64 bytes.
protected  short spreadSpectrum
          Spread spectrum :This field shall indicate the spread spectrum technique or combination of spread spectrum techniques in use.
protected  UnsignedShort system
          System : This field shall specify the interpretation of the Modulation Parameter field(s) in the Transmitter PDU.
 
Constructor Summary
ModulationType()
          Constructs an new ModulationType Object, centered.
ModulationType(short pSpreadSpectrum, UnsignedShort pMajor, UnsignedShort pDetail, UnsignedShort pSystem)
          Constructs a new ModulationType Object whose field values are passed in parameters.
 
Method Summary
 java.lang.Object clone()
          Make a copy of the object.
 void deSerialize(java.io.DataInputStream pInputStream)
          Reads an object in from DIS format.
 UnsignedShort getDetail()
          Gets Detail
 UnsignedShort getMajor()
          Gets Major
 short getSpreadSpectrum()
          Gets SpreadSpectrum
 UnsignedShort getSystem()
          Gets System
 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 setDetail(UnsignedShort pDetail)
          Sets Detail
 void setMajor(UnsignedShort pMajor)
          Sets Major
 void setSpreadSpectrum(short pSpreadSpectrum)
          Sets SpreadSpectrum
 void setSystem(UnsignedShort pSystem)
          Sets System
 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

spreadSpectrum

protected short spreadSpectrum
Spread spectrum :This field shall indicate the spread spectrum technique or combination of spread spectrum techniques in use. The Spread Spectrum Țeld shall consist of a 16 element Boolean array. Each independent type of spread spectrum technique shall be represented by a single element of this array. If a particular spread spectrum technique is in use, the corresponding array element shall be set to one, otherwise it shall be set to zero. All unused array elements shall be set to zero. The supported spread spectrum techniques and their assignment to elements of the 16 element array are defined in Section 9 of EBV-DOC and illustrated in table 23.


major

protected UnsignedShort major
Major :Major Modulation Type. This field shall specify the major classiȚcation of the modulation type. This field shall be represented by a 16-bit enumeration (see Section 9 of EBV-DOC).


detail

protected UnsignedShort detail
Detail : This field shall provide certain detailed information depending upon the major modulation type. This field shall be represented by a 16-bit enumeration (see Section 9 of EBV-DOC).


system

protected UnsignedShort system
System : This field shall specify the interpretation of the Modulation Parameter field(s) in the Transmitter PDU. This field shall be represented by a 16-bit enumeration (see Section 9 of EBV-DOC).


sizeOf

public final int sizeOf
Constant value--size of a World Coordinate record when written out; here :sizeOf = 64 bytes.

See Also:
Constant Field Values
Constructor Detail

ModulationType

public ModulationType()
Constructs an new ModulationType Object, centered.


ModulationType

public ModulationType(short pSpreadSpectrum,
                      UnsignedShort pMajor,
                      UnsignedShort pDetail,
                      UnsignedShort pSystem)
Constructs a new ModulationType Object whose field values are passed in parameters.

Parameters:
pSpreadSpectrum - the first field in the ModulationType Object.
pMajor - the second field in the ModulationType Object.
pDetail - the third field in the ModulationType Object.
pSystem - the third field in the ModulationType Object.
Method Detail

clone

public java.lang.Object clone()
Make a copy of the object. This requires a deep copy, so we don't have two objects sharing pointers to the same data.

Overrides:
clone in class PduElement
Returns:
a new ModulationType
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

getSpreadSpectrum

public short getSpreadSpectrum()
Gets SpreadSpectrum

Returns:
spreadSpectrum

setSpreadSpectrum

public void setSpreadSpectrum(short pSpreadSpectrum)
Sets SpreadSpectrum

Parameters:
pSpreadSpectrum - a SpreadSpectrum

getMajor

public UnsignedShort getMajor()
Gets Major

Returns:
major

setMajor

public void setMajor(UnsignedShort pMajor)
Sets Major

Parameters:
pMajor - a Major

getDetail

public UnsignedShort getDetail()
Gets Detail

Returns:
detail

setDetail

public void setDetail(UnsignedShort pDetail)
Sets Detail

Parameters:
pDetail - a Detail

getSystem

public UnsignedShort getSystem()
Gets System

Returns:
System

setSystem

public void setSystem(UnsignedShort pSystem)
Sets System

Parameters:
pSystem - a System

toString

public java.lang.String toString()
String toString Used for debuging