Class TransmitterPdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.PduBase

edu.nps.moves.dis7.pdus.RadioCommunicationsFamilyPdu

edu.nps.moves.dis7.pdus.TransmitterPdu

All Implemented Interfaces:

Marshaller, Serializable

public class TransmitterPdu
extends RadioCommunicationsFamilyPdu
implements Serializable

5.8.3 Communicates the state of a particular radio transmitter or simple intercom.

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 Vector3Double	antennaLocation	Location of antenna
protected short	antennaPatternCount	atenna pattern length
protected List<VariableTransmitterParameters>	antennaPatternList	variable length list of antenna pattern records
protected TransmitterAntennaPatternType	antennaPatternType	antenna pattern type uid 167
protected ByteArrayOutputStream	byteArrayOutputStream	byteArrayOutputStream (baos) is used for marshal/unmarshal serialization
protected short	cryptoKeyId	crypto system key identifer
protected TransmitterCryptoSystem	cryptoSystem	crypto system enumeration uid 166
protected DataOutputStream	dataOutputStream	dataOutputStream (dos) is used for marshal/unmarshal serialization
protected long	frequency	frequency
protected RadioCommsHeader	header	header is an undescribed parameter...
protected TransmitterInputSource	inputSource	input source uid 165
protected byte	modulationParameterCount	how many modulation parameters we have
protected List<ModulationParameters>	modulationParametersList	variable length list of modulation parameters
protected ModulationType	modulationType	modulation
static final String	NAME	The name of this PDU type
protected byte	padding1	padding1 is an undescribed parameter...
protected short	padding2	padding2 is an undescribed parameter...
protected float	power	transmission power
protected RadioType	radioEntityType	Type of radio
protected Vector3Float	relativeAntennaLocation	relative location of antenna
protected float	transmitFrequencyBandwidth	transmit frequency Bandwidth
protected TransmitterTransmitState	transmitState	transmit state uid 164
protected short	variableTransmitterParameterCount	count field

Fields inherited from class edu.nps.moves.dis7.pdus.RadioCommunicationsFamilyPdu

FAMILY_NAME

Fields inherited from class edu.nps.moves.dis7.pdus.PduBase

padding, pduStatus

Fields inherited from class edu.nps.moves.dis7.pdus.Pdu

exerciseID, length, pduType, protocolFamily, protocolVersion, timestamp

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
TransmitterPdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
TransmitterPdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
TransmitterPdu	copyDataOutputStream()	copy method creates a deep copy of current object using DataOutputStream methods.
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
Vector3Double	getAntennaLocation()	Getter for antennaLocation
List<VariableTransmitterParameters>	getAntennaPatternList()	Getter for antennaPatternList
TransmitterAntennaPatternType	getAntennaPatternType()	Getter for antennaPatternType
short	getCryptoKeyId()	Getter for cryptoKeyId
TransmitterCryptoSystem	getCryptoSystem()	Getter for cryptoSystem
long	getFrequency()	Getter for frequency
RadioCommsHeader	getHeader()	Getter for header
TransmitterInputSource	getInputSource()	Getter for inputSource
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
List<ModulationParameters>	getModulationParametersList()	Getter for modulationParametersList
ModulationType	getModulationType()	Getter for modulationType
byte	getPadding1()	Getter for padding1
short	getPadding2()	Getter for padding2
float	getPower()	Getter for power
RadioType	getRadioEntityType()	Getter for radioEntityType
Vector3Float	getRelativeAntennaLocation()	Getter for relativeAntennaLocation
float	getTransmitFrequencyBandwidth()	Getter for transmitFrequencyBandwidth
TransmitterTransmitState	getTransmitState()	Getter for transmitState
short	getVariableTransmitterParameterCount()	Getter for variableTransmitterParameterCount
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
TransmitterPdu	setAntennaLocation(Vector3Double pAntennaLocation)	Setter for antennaLocation
TransmitterPdu	setAntennaPatternList(List<VariableTransmitterParameters> pAntennaPatternList)	Setter for antennaPatternList
TransmitterPdu	setAntennaPatternType(TransmitterAntennaPatternType pAntennaPatternType)	Setter for antennaPatternType
TransmitterPdu	setCryptoKeyId(int pCryptoKeyId)	Utility setter for cryptoKeyId
TransmitterPdu	setCryptoKeyId(short pCryptoKeyId)	Setter for cryptoKeyId
TransmitterPdu	setCryptoSystem(TransmitterCryptoSystem pCryptoSystem)	Setter for cryptoSystem
TransmitterPdu	setFrequency(int pFrequency)	Utility setter for frequency
TransmitterPdu	setFrequency(long pFrequency)	Setter for frequency
TransmitterPdu	setHeader(RadioCommsHeader pHeader)	Setter for header
TransmitterPdu	setInputSource(TransmitterInputSource pInputSource)	Setter for inputSource
TransmitterPdu	setModulationParametersList(List<ModulationParameters> pModulationParametersList)	Setter for modulationParametersList
TransmitterPdu	setModulationType(ModulationType pModulationType)	Setter for modulationType
TransmitterPdu	setPadding1(byte pPadding1)	Setter for padding1
TransmitterPdu	setPadding1(int pPadding1)	Utility setter for padding1
TransmitterPdu	setPadding2(int pPadding2)	Utility setter for padding2
TransmitterPdu	setPadding2(short pPadding2)	Setter for padding2
TransmitterPdu	setPower(float pPower)	Setter for power
TransmitterPdu	setRadioEntityType(RadioType pRadioEntityType)	Setter for radioEntityType
TransmitterPdu	setRelativeAntennaLocation(Vector3Float pRelativeAntennaLocation)	Setter for relativeAntennaLocation
TransmitterPdu	setTransmitFrequencyBandwidth(float pTransmitFrequencyBandwidth)	Setter for transmitFrequencyBandwidth
TransmitterPdu	setTransmitState(TransmitterTransmitState pTransmitState)	Setter for transmitState
TransmitterPdu	setVariableTransmitterParameterCount(int pVariableTransmitterParameterCount)	Utility setter for variableTransmitterParameterCount
TransmitterPdu	setVariableTransmitterParameterCount(short pVariableTransmitterParameterCount)	Setter for variableTransmitterParameterCount
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 edu.nps.moves.dis7.pdus.PduBase

getPadding, getPduStatus, setPadding, setPadding, setPduStatus

Methods inherited from class edu.nps.moves.dis7.pdus.Pdu

copyByPduFactory, getExerciseID, getLength, getPduType, getProtocolFamily, getProtocolVersion, getTimestamp, getTimestampSeconds, isAcknowledgeRPdu, isActionRequestPdu, isActionRequestRPdu, isActionResponsePdu, isActionResponseRPdu, isAggregateStatePdu, isAppearancePdu, isArealObjectStatePdu, isArticulatedPartsPdu, isAttributePdu, isCollisionElasticPdu, isCollisionPdu, isCommentPdu, isCommentRPdu, isCreateEntityPdu, isCreateEntityRPdu, isDataPdu, isDataQueryPdu, isDataQueryRPdu, isDataRPdu, isDesignatorPdu, isDetonationPdu, isDirectedEnergyFirePdu, isDistributedEmissionsRegenerationFamilyPdu, isElectromagneticEmissionPdu, isEntityDamageStatusPdu, isEntityInformationInteractionFamilyPdu, isEntityManagementFamilyPdu, isEntityStatePdu, isEntityStateUpdatePdu, isEnvironmentalProcessPdu, isEventReportPdu, isEventReportRPdu, isFirePdu, isGriddedDataPdu, isIFFPdu, isInformationOperationsActionPdu, isInformationOperationsFamilyPdu, isInformationOperationsReportPdu, isIntercomControlPdu, isIntercomSignalPdu, isIsGroupOfPdu, isIsPartOfPdu, isLEDetonationPdu, isLEFirePdu, isLinearObjectStatePdu, isLiveEntityDetonationPdu, isLiveEntityFirePdu, isLogisticsFamilyPdu, isMinefieldDataPdu, isMinefieldFamilyPdu, isMinefieldQueryPdu, isMinefieldResponseNACKPdu, isMinefieldStatePdu, isPointObjectStatePdu, isRadioCommunicationsFamilyPdu, isReceiverPdu, isRecordQueryRPdu, isRecordRPdu, isReliablePdu, isRemoveEntityPdu, isRemoveEntityRPdu, isRepairCompletePdu, isRepairResponsePdu, isResupplyCancelPdu, isResupplyOfferPdu, isResupplyReceivedPdu, isSEESPdu, isSetDataPdu, isSetDataRPdu, isSetRecordRPdu, isSignalPdu, isSimulationManagementFamilyPdu, isSimulationManagementWithReliabilityFamilyPdu, isStartResumePdu, isStartResumeRPdu, isStopFreezePdu, isStopFreezeRPdu, isSupplementalEmissionEntityStatePdu, isSyntheticEnvironmentFamilyPdu, isTransferOwnershipPdu, isTransmitterPdu, isTSPIPdu, isUnderwaterAcousticPdu, isWarfareFamilyPdu, marshal, occursAfter, occursBefore, occursSameTime, setExerciseID, setExerciseID, setLength, setLength, setPduType, setProtocolFamily, setProtocolVersion, setTimestamp, setTimestampSeconds

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

The name of this PDU type

See Also:

• Constant Field Values

header

protected RadioCommsHeader header

header is an undescribed parameter...

radioEntityType

protected RadioType radioEntityType

Type of radio

transmitState

protected TransmitterTransmitState transmitState

transmit state uid 164

inputSource

protected TransmitterInputSource inputSource

input source uid 165

variableTransmitterParameterCount

protected short variableTransmitterParameterCount

count field

antennaLocation

protected Vector3Double antennaLocation

Location of antenna

relativeAntennaLocation

protected Vector3Float relativeAntennaLocation

relative location of antenna

antennaPatternType

protected TransmitterAntennaPatternType antennaPatternType

antenna pattern type uid 167

antennaPatternCount

protected short antennaPatternCount

atenna pattern length

frequency

protected long frequency

frequency

transmitFrequencyBandwidth

protected float transmitFrequencyBandwidth

transmit frequency Bandwidth

power

protected float power

transmission power

modulationType

protected ModulationType modulationType

modulation

cryptoSystem

protected TransmitterCryptoSystem cryptoSystem

crypto system enumeration uid 166

cryptoKeyId

protected short cryptoKeyId

crypto system key identifer

modulationParameterCount

protected byte modulationParameterCount

how many modulation parameters we have

padding1

protected byte padding1

padding1 is an undescribed parameter...

padding2

protected short padding2

padding2 is an undescribed parameter...

modulationParametersList

protected List<ModulationParameters> modulationParametersList

variable length list of modulation parameters

antennaPatternList

protected List<VariableTransmitterParameters> antennaPatternList

variable length list of antenna pattern records

byteArrayOutputStream

protected ByteArrayOutputStream byteArrayOutputStream

byteArrayOutputStream (baos) is used for marshal/unmarshal serialization

See Also:

• copyDataOutputStream()

dataOutputStream

protected DataOutputStream dataOutputStream

dataOutputStream (dos) is used for marshal/unmarshal serialization

See Also:

• copyDataOutputStream()

Constructor Details

TransmitterPdu

public TransmitterPdu()

Constructor creates and configures a new instance object

Method Details

copy

public TransmitterPdu copy()

copy method creates a deep copy of current object using preferred marshalling method

Returns:

deep copy of PDU

copyByteBuffer

public TransmitterPdu copyByteBuffer()

Creates a "deep copy" of current object using ByteBuffer methods.

Returns:

deep copy of PDU

copyDataOutputStream

public TransmitterPdu copyDataOutputStream()

copy method creates a deep copy of current object using DataOutputStream methods.

Returns:

deep copy of PDU

getMarshalledSize

public int getMarshalledSize()

Returns size of this serialized (marshalled) object in bytes

Specified by:

getMarshalledSize in interface Marshaller

Overrides:

getMarshalledSize in class RadioCommunicationsFamilyPdu

Returns:

serialized size in bytes

See Also:

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

setHeader

public TransmitterPdu setHeader(RadioCommsHeader pHeader)

Setter for header

Parameters:

pHeader - new value of interest

Returns:

same object to permit progressive setters

getHeader

public RadioCommsHeader getHeader()

Getter for header

Returns:

value of interest

setRadioEntityType

public TransmitterPdu setRadioEntityType(RadioType pRadioEntityType)

Setter for radioEntityType

Parameters:

pRadioEntityType - new value of interest

Returns:

same object to permit progressive setters

getRadioEntityType

public RadioType getRadioEntityType()

Getter for radioEntityType

Returns:

value of interest

setTransmitState

public TransmitterPdu setTransmitState(TransmitterTransmitState pTransmitState)

Setter for transmitState

Parameters:

pTransmitState - new value of interest

Returns:

same object to permit progressive setters

getTransmitState

public TransmitterTransmitState getTransmitState()

Getter for transmitState

Returns:

value of interest

setInputSource

public TransmitterPdu setInputSource(TransmitterInputSource pInputSource)

Setter for inputSource

Parameters:

pInputSource - new value of interest

Returns:

same object to permit progressive setters

getInputSource

public TransmitterInputSource getInputSource()

Getter for inputSource

Returns:

value of interest

setVariableTransmitterParameterCount

public TransmitterPdu setVariableTransmitterParameterCount(short pVariableTransmitterParameterCount)

Setter for variableTransmitterParameterCount

Parameters:

pVariableTransmitterParameterCount - new value of interest

Returns:

same object to permit progressive setters

setVariableTransmitterParameterCount

public TransmitterPdu setVariableTransmitterParameterCount(int pVariableTransmitterParameterCount)

Utility setter for variableTransmitterParameterCount

Parameters:

pVariableTransmitterParameterCount - new value of interest

Returns:

same object to permit progressive setters

getVariableTransmitterParameterCount

public short getVariableTransmitterParameterCount()

Getter for variableTransmitterParameterCount

Returns:

value of interest

setAntennaLocation

public TransmitterPdu setAntennaLocation(Vector3Double pAntennaLocation)

Setter for antennaLocation

Parameters:

pAntennaLocation - new value of interest

Returns:

same object to permit progressive setters

getAntennaLocation

public Vector3Double getAntennaLocation()

Getter for antennaLocation

Returns:

value of interest

setRelativeAntennaLocation

public TransmitterPdu setRelativeAntennaLocation(Vector3Float pRelativeAntennaLocation)

Setter for relativeAntennaLocation

Parameters:

pRelativeAntennaLocation - new value of interest

Returns:

same object to permit progressive setters

getRelativeAntennaLocation

public Vector3Float getRelativeAntennaLocation()

Getter for relativeAntennaLocation

Returns:

value of interest

setAntennaPatternType

public TransmitterPdu setAntennaPatternType(TransmitterAntennaPatternType pAntennaPatternType)

Setter for antennaPatternType

Parameters:

pAntennaPatternType - new value of interest

Returns:

same object to permit progressive setters

getAntennaPatternType

public TransmitterAntennaPatternType getAntennaPatternType()

Getter for antennaPatternType

Returns:

value of interest

setFrequency

public TransmitterPdu setFrequency(long pFrequency)

Setter for frequency

Parameters:

pFrequency - new value of interest

Returns:

same object to permit progressive setters

setFrequency

public TransmitterPdu setFrequency(int pFrequency)

Utility setter for frequency

Parameters:

pFrequency - new value of interest

Returns:

same object to permit progressive setters

getFrequency

public long getFrequency()

Getter for frequency

Returns:

value of interest

setTransmitFrequencyBandwidth

public TransmitterPdu setTransmitFrequencyBandwidth(float pTransmitFrequencyBandwidth)

Setter for transmitFrequencyBandwidth

Parameters:

pTransmitFrequencyBandwidth - new value of interest

Returns:

same object to permit progressive setters

getTransmitFrequencyBandwidth

public float getTransmitFrequencyBandwidth()

Getter for transmitFrequencyBandwidth

Returns:

value of interest

setPower

public TransmitterPdu setPower(float pPower)

Setter for power

Parameters:

pPower - new value of interest

Returns:

same object to permit progressive setters

getPower

public float getPower()

Getter for power

Returns:

value of interest

setModulationType

public TransmitterPdu setModulationType(ModulationType pModulationType)

Setter for modulationType

Parameters:

pModulationType - new value of interest

Returns:

same object to permit progressive setters

getModulationType

public ModulationType getModulationType()

Getter for modulationType

Returns:

value of interest

setCryptoSystem

public TransmitterPdu setCryptoSystem(TransmitterCryptoSystem pCryptoSystem)

Setter for cryptoSystem

Parameters:

pCryptoSystem - new value of interest

Returns:

same object to permit progressive setters

getCryptoSystem

public TransmitterCryptoSystem getCryptoSystem()

Getter for cryptoSystem

Returns:

value of interest

setCryptoKeyId

public TransmitterPdu setCryptoKeyId(short pCryptoKeyId)

Setter for cryptoKeyId

Parameters:

pCryptoKeyId - new value of interest

Returns:

same object to permit progressive setters

setCryptoKeyId

public TransmitterPdu setCryptoKeyId(int pCryptoKeyId)

Utility setter for cryptoKeyId

Parameters:

pCryptoKeyId - new value of interest

Returns:

same object to permit progressive setters

getCryptoKeyId

public short getCryptoKeyId()

Getter for cryptoKeyId

Returns:

value of interest

setPadding1

public TransmitterPdu setPadding1(byte pPadding1)

Setter for padding1

Parameters:

pPadding1 - new value of interest

Returns:

same object to permit progressive setters

setPadding1

public TransmitterPdu setPadding1(int pPadding1)

Utility setter for padding1

Parameters:

pPadding1 - new value of interest

Returns:

same object to permit progressive setters

getPadding1

public byte getPadding1()

Getter for padding1

Returns:

value of interest

setPadding2

public TransmitterPdu setPadding2(short pPadding2)

Setter for padding2

Parameters:

pPadding2 - new value of interest

Returns:

same object to permit progressive setters

setPadding2

public TransmitterPdu setPadding2(int pPadding2)

Utility setter for padding2

Parameters:

pPadding2 - new value of interest

Returns:

same object to permit progressive setters

getPadding2

public short getPadding2()

Getter for padding2

Returns:

value of interest

setModulationParametersList

public TransmitterPdu setModulationParametersList(List<ModulationParameters> pModulationParametersList)

Setter for modulationParametersList

Parameters:

pModulationParametersList - new value of interest

Returns:

same object to permit progressive setters

getModulationParametersList

public List<ModulationParameters> getModulationParametersList()

Getter for modulationParametersList

Returns:

value of interest

setAntennaPatternList

public TransmitterPdu setAntennaPatternList(List<VariableTransmitterParameters> pAntennaPatternList)

Setter for antennaPatternList

Parameters:

pAntennaPatternList - new value of interest

Returns:

same object to permit progressive setters

getAntennaPatternList

public List<VariableTransmitterParameters> getAntennaPatternList()

Getter for antennaPatternList

Returns:

value of interest

marshal

public void marshal(DataOutputStream dos)
             throws Exception

Serializes an object to a DataOutputStream.

Specified by:

marshal in interface Marshaller

Overrides:

marshal in class RadioCommunicationsFamilyPdu

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.

Specified by:

unmarshal in interface Marshaller

Overrides:

unmarshal in class RadioCommunicationsFamilyPdu

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.

Specified by:

marshal in interface Marshaller

Overrides:

marshal in class RadioCommunicationsFamilyPdu

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.

Specified by:

unmarshal in interface Marshaller

Overrides:

unmarshal in class RadioCommunicationsFamilyPdu

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 RadioCommunicationsFamilyPdu

equalsImpl

public boolean equalsImpl(Object obj)

Description copied from class: Pdu

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

Overrides:

equalsImpl in class RadioCommunicationsFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class RadioCommunicationsFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class PduBase