Package edu.nps.moves.dis7.pdus
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
5.8.3 Communicates the state of a particular radio transmitter or simple intercom.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Vector3DoubleLocation of antennaprotected shortatenna pattern lengthprotected List<VariableTransmitterParameters>variable length list of antenna pattern recordsprotected TransmitterAntennaPatternTypeantenna pattern type uid 167protected ByteArrayOutputStreambyteArrayOutputStream (baos) is used for marshal/unmarshal serializationprotected shortcrypto system key identiferprotected TransmitterCryptoSystemcrypto system enumeration uid 166protected DataOutputStreamdataOutputStream (dos) is used for marshal/unmarshal serializationprotected longfrequencyprotected RadioCommsHeaderheader is an undescribed parameter...protected TransmitterInputSourceinput source uid 165protected bytehow many modulation parameters we haveprotected List<ModulationParameters>variable length list of modulation parametersprotected ModulationTypemodulationprotected bytepadding1 is an undescribed parameter...protected shortpadding2 is an undescribed parameter...protected floattransmission powerprotected RadioTypeType of radioprotected shortparticular radio within an entityprotected Vector3Floatrelative location of antennaprotected floattransmit frequency Bandwidthprotected TransmitterTransmitStatetransmit state uid 164protected shortcount fieldFields inherited from class edu.nps.moves.dis7.pdus.Pdu
exerciseID, length, pduType, protocolFamily, protocolVersion, timestamp -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncopy()copy method creates a deep copy of current object using preferred marshalling methodCreates a "deep copy" of current object using ByteBuffer methods.copy method creates a deep copy of current object using DataOutputStream methods.booleanbooleanequalsImpl(Object obj) Compare all fields that contribute to the state, ignoring transient and static fields, forthisand the supplied objectGetter forantennaLocationGetter forantennaPatternListGetter forantennaPatternTypeshortGetter forcryptoKeyIdGetter forcryptoSystemlongGetter forfrequencyGetter forheaderGetter forinputSourceintReturns size of this serialized (marshalled) object in bytesGetter formodulationParametersListGetter formodulationTypebyteGetter forpadding1shortGetter forpadding2floatgetPower()Getter forpowerGetter forradioEntityTypeshortGetter forradioNumberGetter forrelativeAntennaLocationfloatGetter fortransmitFrequencyBandwidthGetter fortransmitStateshortGetter forvariableTransmitterParameterCountvoidmarshal(DataOutputStream dos) Serializes an object to a DataOutputStream.voidmarshal(ByteBuffer byteBuffer) Packs an object into the ByteBuffer.setAntennaLocation(Vector3Double pAntennaLocation) Setter forantennaLocationsetAntennaPatternList(List<VariableTransmitterParameters> pAntennaPatternList) Setter forantennaPatternListsetAntennaPatternType(TransmitterAntennaPatternType pAntennaPatternType) Setter forantennaPatternTypesetCryptoKeyId(int pCryptoKeyId) Utility setter forcryptoKeyIdsetCryptoKeyId(short pCryptoKeyId) Setter forcryptoKeyIdsetCryptoSystem(TransmitterCryptoSystem pCryptoSystem) Setter forcryptoSystemsetFrequency(int pFrequency) Utility setter forfrequencysetFrequency(long pFrequency) Setter forfrequencysetHeader(RadioCommsHeader pHeader) Setter forheadersetInputSource(TransmitterInputSource pInputSource) Setter forinputSourcesetModulationParametersList(List<ModulationParameters> pModulationParametersList) Setter formodulationParametersListsetModulationType(ModulationType pModulationType) Setter formodulationTypesetPadding1(byte pPadding1) Setter forpadding1setPadding1(int pPadding1) Utility setter forpadding1setPadding2(int pPadding2) Utility setter forpadding2setPadding2(short pPadding2) Setter forpadding2setPower(float pPower) Setter forpowersetRadioEntityType(RadioType pRadioEntityType) Setter forradioEntityTypesetRadioNumber(int pRadioNumber) Utility setter forradioNumbersetRadioNumber(short pRadioNumber) Setter forradioNumbersetRelativeAntennaLocation(Vector3Float pRelativeAntennaLocation) Setter forrelativeAntennaLocationsetTransmitFrequencyBandwidth(float pTransmitFrequencyBandwidth) Setter fortransmitFrequencyBandwidthsetTransmitState(TransmitterTransmitState pTransmitState) Setter fortransmitStatesetVariableTransmitterParameterCount(int pVariableTransmitterParameterCount) Utility setter forvariableTransmitterParameterCountsetVariableTransmitterParameterCount(short pVariableTransmitterParameterCount) Setter forvariableTransmitterParameterCounttoString()intunmarshal(DataInputStream dis) Deserializes an object from a DataInputStream.intunmarshal(ByteBuffer byteBuffer) Unpacks a Pdu from the underlying data.Methods inherited from class edu.nps.moves.dis7.pdus.PduBase
getPadding, getPduStatus, setPadding, setPadding, setPduStatusMethods inherited from class edu.nps.moves.dis7.pdus.Pdu
copyByPduFactory, getExerciseID, getLength, getPduType, getProtocolFamily, getProtocolVersion, getTimestamp, getTimestampSeconds, marshal, occursAfter, occursBefore, occursSameTime, setExerciseID, setExerciseID, setLength, setLength, setPduType, setProtocolFamily, setProtocolVersion, setTimestamp, setTimestampSeconds
-
Field Details
-
header
header is an undescribed parameter... -
radioNumber
protected short radioNumberparticular radio within an entity -
radioEntityType
Type of radio -
transmitState
transmit state uid 164 -
inputSource
input source uid 165 -
variableTransmitterParameterCount
protected short variableTransmitterParameterCountcount field -
antennaLocation
Location of antenna -
relativeAntennaLocation
relative location of antenna -
antennaPatternType
antenna pattern type uid 167 -
antennaPatternCount
protected short antennaPatternCountatenna pattern length -
frequency
protected long frequencyfrequency -
transmitFrequencyBandwidth
protected float transmitFrequencyBandwidthtransmit frequency Bandwidth -
power
protected float powertransmission power -
modulationType
modulation -
cryptoSystem
crypto system enumeration uid 166 -
cryptoKeyId
protected short cryptoKeyIdcrypto system key identifer -
modulationParameterCount
protected byte modulationParameterCounthow many modulation parameters we have -
padding1
protected byte padding1padding1 is an undescribed parameter... -
padding2
protected short padding2padding2 is an undescribed parameter... -
modulationParametersList
variable length list of modulation parameters -
antennaPatternList
variable length list of antenna pattern records -
byteArrayOutputStream
byteArrayOutputStream (baos) is used for marshal/unmarshal serialization- See Also:
-
dataOutputStream
dataOutputStream (dos) is used for marshal/unmarshal serialization- See Also:
-
-
Constructor Details
-
TransmitterPdu
public TransmitterPdu()Constructor creates and configures a new instance object
-
-
Method Details
-
copy
copy method creates a deep copy of current object using preferred marshalling method- Returns:
- deep copy of PDU
-
copyByteBuffer
Creates a "deep copy" of current object using ByteBuffer methods.- Returns:
- deep copy of PDU
-
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:
getMarshalledSizein interfaceMarshaller- Overrides:
getMarshalledSizein classRadioCommunicationsFamilyPdu- Returns:
- serialized size in bytes
- See Also:
-
setHeader
Setter forheader- Parameters:
pHeader- new value of interest- Returns:
- same object to permit progressive setters
-
getHeader
Getter forheader- Returns:
- value of interest
-
setRadioNumber
Setter forradioNumber- Parameters:
pRadioNumber- new value of interest- Returns:
- same object to permit progressive setters
-
setRadioNumber
Utility setter forradioNumber- Parameters:
pRadioNumber- new value of interest- Returns:
- same object to permit progressive setters
-
getRadioNumber
public short getRadioNumber()Getter forradioNumber- Returns:
- value of interest
-
setRadioEntityType
Setter forradioEntityType- Parameters:
pRadioEntityType- new value of interest- Returns:
- same object to permit progressive setters
-
getRadioEntityType
Getter forradioEntityType- Returns:
- value of interest
-
setTransmitState
Setter fortransmitState- Parameters:
pTransmitState- new value of interest- Returns:
- same object to permit progressive setters
-
getTransmitState
Getter fortransmitState- Returns:
- value of interest
-
setInputSource
Setter forinputSource- Parameters:
pInputSource- new value of interest- Returns:
- same object to permit progressive setters
-
getInputSource
Getter forinputSource- Returns:
- value of interest
-
setVariableTransmitterParameterCount
public TransmitterPdu setVariableTransmitterParameterCount(short pVariableTransmitterParameterCount) Setter forvariableTransmitterParameterCount- Parameters:
pVariableTransmitterParameterCount- new value of interest- Returns:
- same object to permit progressive setters
-
setVariableTransmitterParameterCount
Utility setter forvariableTransmitterParameterCount- Parameters:
pVariableTransmitterParameterCount- new value of interest- Returns:
- same object to permit progressive setters
-
getVariableTransmitterParameterCount
public short getVariableTransmitterParameterCount()Getter forvariableTransmitterParameterCount- Returns:
- value of interest
-
setAntennaLocation
Setter forantennaLocation- Parameters:
pAntennaLocation- new value of interest- Returns:
- same object to permit progressive setters
-
getAntennaLocation
Getter forantennaLocation- Returns:
- value of interest
-
setRelativeAntennaLocation
Setter forrelativeAntennaLocation- Parameters:
pRelativeAntennaLocation- new value of interest- Returns:
- same object to permit progressive setters
-
getRelativeAntennaLocation
Getter forrelativeAntennaLocation- Returns:
- value of interest
-
setAntennaPatternType
Setter forantennaPatternType- Parameters:
pAntennaPatternType- new value of interest- Returns:
- same object to permit progressive setters
-
getAntennaPatternType
Getter forantennaPatternType- Returns:
- value of interest
-
setFrequency
Setter forfrequency- Parameters:
pFrequency- new value of interest- Returns:
- same object to permit progressive setters
-
setFrequency
Utility setter forfrequency- Parameters:
pFrequency- new value of interest- Returns:
- same object to permit progressive setters
-
getFrequency
public long getFrequency()Getter forfrequency- Returns:
- value of interest
-
setTransmitFrequencyBandwidth
Setter fortransmitFrequencyBandwidth- Parameters:
pTransmitFrequencyBandwidth- new value of interest- Returns:
- same object to permit progressive setters
-
getTransmitFrequencyBandwidth
public float getTransmitFrequencyBandwidth()Getter fortransmitFrequencyBandwidth- Returns:
- value of interest
-
setPower
Setter forpower- Parameters:
pPower- new value of interest- Returns:
- same object to permit progressive setters
-
getPower
public float getPower()Getter forpower- Returns:
- value of interest
-
setModulationType
Setter formodulationType- Parameters:
pModulationType- new value of interest- Returns:
- same object to permit progressive setters
-
getModulationType
Getter formodulationType- Returns:
- value of interest
-
setCryptoSystem
Setter forcryptoSystem- Parameters:
pCryptoSystem- new value of interest- Returns:
- same object to permit progressive setters
-
getCryptoSystem
Getter forcryptoSystem- Returns:
- value of interest
-
setCryptoKeyId
Setter forcryptoKeyId- Parameters:
pCryptoKeyId- new value of interest- Returns:
- same object to permit progressive setters
-
setCryptoKeyId
Utility setter forcryptoKeyId- Parameters:
pCryptoKeyId- new value of interest- Returns:
- same object to permit progressive setters
-
getCryptoKeyId
public short getCryptoKeyId()Getter forcryptoKeyId- Returns:
- value of interest
-
setPadding1
Setter forpadding1- Parameters:
pPadding1- new value of interest- Returns:
- same object to permit progressive setters
-
setPadding1
Utility setter forpadding1- Parameters:
pPadding1- new value of interest- Returns:
- same object to permit progressive setters
-
getPadding1
public byte getPadding1()Getter forpadding1- Returns:
- value of interest
-
setPadding2
Setter forpadding2- Parameters:
pPadding2- new value of interest- Returns:
- same object to permit progressive setters
-
setPadding2
Utility setter forpadding2- Parameters:
pPadding2- new value of interest- Returns:
- same object to permit progressive setters
-
getPadding2
public short getPadding2()Getter forpadding2- Returns:
- value of interest
-
setModulationParametersList
public TransmitterPdu setModulationParametersList(List<ModulationParameters> pModulationParametersList) Setter formodulationParametersList- Parameters:
pModulationParametersList- new value of interest- Returns:
- same object to permit progressive setters
-
getModulationParametersList
Getter formodulationParametersList- Returns:
- value of interest
-
setAntennaPatternList
public TransmitterPdu setAntennaPatternList(List<VariableTransmitterParameters> pAntennaPatternList) Setter forantennaPatternList- Parameters:
pAntennaPatternList- new value of interest- Returns:
- same object to permit progressive setters
-
getAntennaPatternList
Getter forantennaPatternList- Returns:
- value of interest
-
marshal
Serializes an object to a DataOutputStream.- Specified by:
marshalin interfaceMarshaller- Overrides:
marshalin classRadioCommunicationsFamilyPdu- Parameters:
dos- the OutputStream- Throws:
Exception- if something goes wrong- See Also:
-
unmarshal
Deserializes an object from a DataInputStream.- Specified by:
unmarshalin interfaceMarshaller- Overrides:
unmarshalin classRadioCommunicationsFamilyPdu- Parameters:
dis- the InputStream- Returns:
- marshalled serialized size in bytes
- Throws:
Exception- if something goes wrong- See Also:
-
marshal
Packs an object into the ByteBuffer.- Specified by:
marshalin interfaceMarshaller- Overrides:
marshalin classRadioCommunicationsFamilyPdu- Parameters:
byteBuffer- The ByteBuffer at the position to begin writing- Throws:
BufferOverflowException- if byteBuffer is too smallReadOnlyBufferException- if byteBuffer is read onlyException- ByteBuffer-generated exception- See Also:
-
unmarshal
Unpacks a Pdu from the underlying data.- Specified by:
unmarshalin interfaceMarshaller- Overrides:
unmarshalin classRadioCommunicationsFamilyPdu- Parameters:
byteBuffer- The ByteBuffer at the position to begin reading- Returns:
- marshalled serialized size in bytes
- Throws:
BufferUnderflowException- if byteBuffer is too smallException- ByteBuffer-generated exception- See Also:
-
equals
- Overrides:
equalsin classRadioCommunicationsFamilyPdu
-
equalsImpl
Description copied from class:PduCompare all fields that contribute to the state, ignoring transient and static fields, forthisand the supplied object- Overrides:
equalsImplin classRadioCommunicationsFamilyPdu- Parameters:
obj- the object to compare to- Returns:
- true if the objects are equal, false otherwise.
-
toString
- Overrides:
toStringin classRadioCommunicationsFamilyPdu
-