Class SignalPdu

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.SignalPdu

All Implemented Interfaces:

Marshaller, Serializable

public class SignalPdu
extends RadioCommunicationsFamilyPdu
implements Serializable

5.8.4, 7.7.3 Conveys the audio or digital data carried by the simulated radio or intercom transmission. IEEE Std 1278.1-2012, IEEE Standard for Distributed Interactive Simulation—Application Protocols

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected byte[]	data	list of eight bit values
protected Short	dataLength	length of data in bits
protected short	encodingScheme	encoding scheme used, and enumeration
protected RadioCommsHeader	header	Radio communications header
protected int	sampleRate	sample rate
protected short	samples	number of samples
protected SignalTDLType	tdlType	tdl type uid 178

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, NAME, pduType, protocolFamily, protocolVersion, timestamp

Constructor Summary

Constructors

Constructor	Description
SignalPdu()	Constructor

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
byte[]	getData()	Getter for data
short	getDataLength()	Getter for dataLength
short	getEncodingScheme()	Getter for encodingScheme
RadioCommsHeader	getHeader()	Getter for header
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
int	getSampleRate()	Getter for sampleRate
short	getSamples()	Getter for samples
SignalTDLType	getTdlType()	Getter for tdlType
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
SignalPdu	setData(byte[] pData)	Setter for data
SignalPdu	setDataLength(short pDataLength)	Setter for dataLength
SignalPdu	setEncodingScheme(short pEncodingScheme)	Setter for encodingScheme
SignalPdu	setHeader(RadioCommsHeader pHeader)	Setter for header
SignalPdu	setSampleRate(int pSampleRate)	Setter for sampleRate
SignalPdu	setSamples(short pSamples)	Setter for samples
SignalPdu	setTdlType(SignalTDLType pTdlType)	Setter for tdlType
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.RadioCommunicationsFamilyPdu

toString

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

getPadding, getPduStatus, hashCode, 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

header

protected RadioCommsHeader header

Radio communications header

encodingScheme

protected short encodingScheme

encoding scheme used, and enumeration

tdlType

protected SignalTDLType tdlType

tdl type uid 178

sampleRate

protected int sampleRate

sample rate

dataLength

protected Short dataLength

length of data in bits

samples

protected short samples

number of samples

data

protected byte[] data

list of eight bit values

Constructor Details

SignalPdu

public SignalPdu()

Constructor

Method Details

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 SignalPdu setHeader(RadioCommsHeader pHeader)

Setter for header

Parameters:

pHeader - value of interest

Returns:

same object to permit progressive setters

getHeader

public RadioCommsHeader getHeader()

Getter for header

Returns:

header

setEncodingScheme

public SignalPdu setEncodingScheme(short pEncodingScheme)

Setter for encodingScheme

Parameters:

pEncodingScheme - value of interest

Returns:

same object to permit progressive setters

getEncodingScheme

public short getEncodingScheme()

Getter for encodingScheme

Returns:

encodingScheme

setTdlType

public SignalPdu setTdlType(SignalTDLType pTdlType)

Setter for tdlType

Parameters:

pTdlType - of interest

Returns:

same object to permit progressive setters

getTdlType

public SignalTDLType getTdlType()

Getter for tdlType

Returns:

value of interest

setSampleRate

public SignalPdu setSampleRate(int pSampleRate)

Setter for sampleRate

Parameters:

pSampleRate - of interest

Returns:

same object to permit progressive setters

getSampleRate

public int getSampleRate()

Getter for sampleRate

Returns:

sampleRate

setDataLength

public SignalPdu setDataLength(short pDataLength)

Setter for dataLength

This value is the size IN BITS of the dataLength field. Since that field is a byte array, its size must be large enough to contain the specified number of bits. If this size is NOT set and this pdu is issued (marshaled), the value used for this field will be the size of the byte array times 8.

Parameters:

pDataLength - value for field

Returns:

same object to permit progressive setters

getDataLength

public short getDataLength()

Getter for dataLength

Returns:

value of field

setSamples

public SignalPdu setSamples(short pSamples)

Setter for samples

Parameters:

pSamples - value for field

Returns:

same object to permit progressive setters

getSamples

public short getSamples()

Getter for samples

Returns:

value of field

setData

public SignalPdu setData(byte[] pData)

Setter for data

This is described in the specification as a stream of bits, but is implemented in Java as a byte array. The size of the byte array reflects the value of dataLength rounded to the next highest byte boundary. If dataLength is not set when the Pdu is sent, the receiver will read a bit length equal to the size of the byte array times 8.

Parameters:

pData - data of interest

Returns:

same object to permit progressive setters

getData

public byte[] getData()

Getter for data

Returns:

value of field

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 DataOutputStream

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 - DataInputStream

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 buff is too small

ReadOnlyBufferException - if buff 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 buff 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.