Class ModulationType

java.lang.Object

edu.nps.moves.dis7.pdus.ModulationType

All Implemented Interfaces:

Serializable

public class ModulationType
extends Object
implements Serializable

Information about the type of modulation used for radio transmission. 6.2.59

See Also:

• IEEE Std 1278.1-2012, IEEE Standard for Distributed Interactive Simulation - Application Protocols
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected short	detail	provide certain detailed information depending upon the major modulation type, uid 156-162
protected TransmitterMajorModulation	majorModulation	The major classification of the modulation type.
protected TransmitterModulationTypeSystem	radioSystem	The radio system associated with this Transmitter PDU and shall be used as the basis to interpret other fields whose values depend on a specific radio system. uid =163
protected short	spreadSpectrum	This field shall indicate the spread spectrum technique or combination of spread spectrum techniques in use.

Constructor Summary

Constructors

Constructor	Description
ModulationType()	Constructor creates and configures a new instance object

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
boolean	equalsImpl(Object obj)	Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object
short	getDetail()	Getter for detail
TransmitterMajorModulation	getMajorModulation()	Getter for majorModulation
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
TransmitterModulationTypeSystem	getRadioSystem()	Getter for radioSystem
short	getSpreadSpectrum()	Getter for spreadSpectrum
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
ModulationType	setDetail(int pDetail)	Utility setter for detail
ModulationType	setDetail(short pDetail)	Setter for detail
ModulationType	setMajorModulation(TransmitterMajorModulation pMajorModulation)	Setter for majorModulation
ModulationType	setRadioSystem(TransmitterModulationTypeSystem pRadioSystem)	Setter for radioSystem
ModulationType	setSpreadSpectrum(int pSpreadSpectrum)	Utility setter for spreadSpectrum
ModulationType	setSpreadSpectrum(short pSpreadSpectrum)	Setter for spreadSpectrum
String	toString()
int	unmarshal(DataInputStream dis)	Deserializes an object from a DataInputStream.
int	unmarshal(ByteBuffer byteBuffer)	Unpacks a Pdu from the underlying data.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

spreadSpectrum

protected short spreadSpectrum

This field shall indicate the spread spectrum technique or combination of spread spectrum techniques in use. Bit field. 0=freq hopping, 1=psuedo noise, time hopping=2, reamining bits unused

majorModulation

protected TransmitterMajorModulation majorModulation

The major classification of the modulation type. UID 155

detail

protected short detail

provide certain detailed information depending upon the major modulation type, uid 156-162

radioSystem

protected TransmitterModulationTypeSystem radioSystem

The radio system associated with this Transmitter PDU and shall be used as the basis to interpret other fields whose values depend on a specific radio system. uid =163

Constructor Details

ModulationType

public ModulationType()

Constructor creates and configures a new instance object

Method Details

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)

setSpreadSpectrum

public ModulationType setSpreadSpectrum(short pSpreadSpectrum)

Setter for spreadSpectrum

Parameters:

pSpreadSpectrum - new value of interest

Returns:

same object to permit progressive setters

setSpreadSpectrum

public ModulationType setSpreadSpectrum(int pSpreadSpectrum)

Utility setter for spreadSpectrum

Parameters:

pSpreadSpectrum - new value of interest

Returns:

same object to permit progressive setters

getSpreadSpectrum

public short getSpreadSpectrum()

Getter for spreadSpectrum

Returns:

value of interest

setMajorModulation

public ModulationType setMajorModulation(TransmitterMajorModulation pMajorModulation)

Setter for majorModulation

Parameters:

pMajorModulation - new value of interest

Returns:

same object to permit progressive setters

getMajorModulation

public TransmitterMajorModulation getMajorModulation()

Getter for majorModulation

Returns:

value of interest

setDetail

public ModulationType setDetail(short pDetail)

Setter for detail

Parameters:

pDetail - new value of interest

Returns:

same object to permit progressive setters

setDetail

public ModulationType setDetail(int pDetail)

Utility setter for detail

Parameters:

pDetail - new value of interest

Returns:

same object to permit progressive setters

getDetail

public short getDetail()

Getter for detail

Returns:

value of interest

setRadioSystem

public ModulationType setRadioSystem(TransmitterModulationTypeSystem pRadioSystem)

Setter for radioSystem

Parameters:

pRadioSystem - new value of interest

Returns:

same object to permit progressive setters

getRadioSystem

public TransmitterModulationTypeSystem getRadioSystem()

Getter for radioSystem

Returns:

value of interest

marshal

public void marshal(DataOutputStream dos)
             throws Exception

Serializes an object to a DataOutputStream.

Parameters:

dos - the OutputStream

Throws:

Exception - if something goes wrong

See Also:

• DataOutputStream

unmarshal

public int unmarshal(DataInputStream dis)
              throws Exception

Deserializes an object from a DataInputStream.

Parameters:

dis - the InputStream

Returns:

marshalled serialized size in bytes

Throws:

Exception - if something goes wrong

See Also:

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

marshal

public void marshal(ByteBuffer byteBuffer)
             throws Exception

Packs an object into the ByteBuffer.

Parameters:

byteBuffer - The ByteBuffer at the position to begin writing

Throws:

BufferOverflowException - if byteBuffer is too small

ReadOnlyBufferException - if byteBuffer is read only

Exception - ByteBuffer-generated exception

See Also:

• ByteBuffer

unmarshal

public int unmarshal(ByteBuffer byteBuffer)
              throws Exception

Unpacks a Pdu from the underlying data.

Parameters:

byteBuffer - The ByteBuffer at the position to begin reading

Returns:

marshalled serialized size in bytes

Throws:

BufferUnderflowException - if byteBuffer is too small

Exception - ByteBuffer-generated exception

See Also:

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsImpl

public boolean equalsImpl(Object obj)

Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object