Class IntercomSignalPdu

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

All Implemented Interfaces:

Marshaller, Serializable

public class IntercomSignalPdu
extends RadioCommunicationsFamilyPdu
implements Serializable

5.8.6 Conveys the audio or digital data that is used to communicate between simulated intercom devices 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	data bytes
protected Short	dataLength	data length
protected short	encodingScheme	encoding scheme
protected short	intercomNumber	ID of communications device
protected IntercomReferenceID	intercomReferenceID	Unique referenceID for this intercom
protected int	sampleRate	sample rate
protected short	samples	samples
protected SignalTDLType	tdlType	tactical data link 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
IntercomSignalPdu()	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 SignalPdu.dataLength
short	getEncodingScheme()	Getter for encodingScheme
short	getIntercomNumber()	Getter for intercomNumber
IntercomReferenceID	getIntercomReferenceID()	Getter for intercomReferenceID
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.
IntercomSignalPdu	setData(byte[] pData)	Setter for data
IntercomSignalPdu	setDataLength(short pDataLength)	Setter for dataLength
IntercomSignalPdu	setEncodingScheme(short pEncodingScheme)	Setter for encodingScheme
IntercomSignalPdu	setIntercomNumber(short pIntercomNumber)	Setter for intercomNumber
IntercomSignalPdu	setIntercomReferenceID(IntercomReferenceID pIntercomReferenceID)	Setter for intercomReferenceID
IntercomSignalPdu	setSampleRate(int pSampleRate)	Setter for sampleRate
IntercomSignalPdu	setSamples(short pSamples)	Setter for samples
IntercomSignalPdu	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

intercomReferenceID

protected IntercomReferenceID intercomReferenceID

Unique referenceID for this intercom

intercomNumber

protected short intercomNumber

ID of communications device

encodingScheme

protected short encodingScheme

encoding scheme

tdlType

protected SignalTDLType tdlType

tactical data link type uid 178

sampleRate

protected int sampleRate

sample rate

dataLength

protected Short dataLength

data length

samples

protected short samples

samples

data

protected byte[] data

data bytes

Constructor Details

IntercomSignalPdu

public IntercomSignalPdu()

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)

setIntercomReferenceID

public IntercomSignalPdu setIntercomReferenceID(IntercomReferenceID pIntercomReferenceID)

Setter for intercomReferenceID

Parameters:

pIntercomReferenceID - ID of interest

Returns:

same object to permit progressive setters

getIntercomReferenceID

public IntercomReferenceID getIntercomReferenceID()

Getter for intercomReferenceID

Returns:

value of interest

setIntercomNumber

public IntercomSignalPdu setIntercomNumber(short pIntercomNumber)

Setter for intercomNumber

Parameters:

pIntercomNumber - value of interest

Returns:

same object to permit progressive setters

getIntercomNumber

public short getIntercomNumber()

Getter for intercomNumber

Returns:

value of interest

setEncodingScheme

public IntercomSignalPdu 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:

value of interest

setTdlType

public IntercomSignalPdu setTdlType(SignalTDLType pTdlType)

Setter for tdlType

Parameters:

pTdlType - value of interest

Returns:

same object to permit progressive setters

getTdlType

public SignalTDLType getTdlType()

Getter for tdlType

Returns:

value of interest

setSampleRate

public IntercomSignalPdu setSampleRate(int pSampleRate)

Setter for sampleRate

Parameters:

pSampleRate - value of interest

Returns:

same object to permit progressive setters

getSampleRate

public int getSampleRate()

Getter for sampleRate

Returns:

value of interest

setDataLength

public IntercomSignalPdu 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:

this object

getDataLength

public short getDataLength()

Getter for SignalPdu.dataLength

Returns:

value of interest

setSamples

public IntercomSignalPdu setSamples(short pSamples)

Setter for samples

Parameters:

pSamples - value of interest

Returns:

same object to permit progressive setters

getSamples

public short getSamples()

Getter for samples

Returns:

value of interest

setData

public IntercomSignalPdu setData(byte[] pData)

Setter for data

Parameters:

pData - value of interest

Returns:

same object to permit progressive setters

getData

public byte[] getData()

Getter for data

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