Class ReceiverPdu

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

All Implemented Interfaces:

Marshaller, Serializable

public class ReceiverPdu
extends RadioCommunicationsFamilyPdu
implements Serializable

5.8.5 Communicates the state of a particular radio receiver. Its primary application is in communicating state information to radio network monitors, data loggers, and similar applications for use in debugging, supervision, and after-action review.

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 ByteArrayOutputStream	byteArrayOutputStream	byteArrayOutputStream (baos) is used for marshal/unmarshal serialization
protected DataOutputStream	dataOutputStream	dataOutputStream (dos) is used for marshal/unmarshal serialization
protected RadioCommsHeader	header	header is an undescribed parameter...
static final String	NAME	The name of this PDU type
protected short	padding1	padding1 is an undescribed parameter...
protected float	receivedPower	received power
protected ReceiverReceiverState	receiverState	encoding scheme used, and enumeration uid 179
protected EntityID	transmitterEntityId	ID of transmitter
protected short	transmitterRadioId	ID of transmitting radio

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
ReceiverPdu()	Constructor creates and configures a new instance object

Method Summary

Modifier and Type	Method	Description
ReceiverPdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
ReceiverPdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
ReceiverPdu	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
RadioCommsHeader	getHeader()	Getter for header
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
short	getPadding1()	Getter for padding1
float	getReceivedPower()	Getter for receivedPower
ReceiverReceiverState	getReceiverState()	Getter for receiverState
EntityID	getTransmitterEntityId()	Getter for transmitterEntityId
short	getTransmitterRadioId()	Getter for transmitterRadioId
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
ReceiverPdu	setHeader(RadioCommsHeader pHeader)	Setter for header
ReceiverPdu	setPadding1(int pPadding1)	Utility setter for padding1
ReceiverPdu	setPadding1(short pPadding1)	Setter for padding1
ReceiverPdu	setReceivedPower(float pReceivedPower)	Setter for receivedPower
ReceiverPdu	setReceiverState(ReceiverReceiverState pReceiverState)	Setter for receiverState
ReceiverPdu	setTransmitterEntityId(EntityID pTransmitterEntityId)	Setter for transmitterEntityId
ReceiverPdu	setTransmitterRadioId(int pTransmitterRadioId)	Utility setter for transmitterRadioId
ReceiverPdu	setTransmitterRadioId(short pTransmitterRadioId)	Setter for transmitterRadioId
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...

receiverState

protected ReceiverReceiverState receiverState

encoding scheme used, and enumeration uid 179

padding1

protected short padding1

padding1 is an undescribed parameter...

receivedPower

protected float receivedPower

received power

transmitterEntityId

protected EntityID transmitterEntityId

ID of transmitter

transmitterRadioId

protected short transmitterRadioId

ID of transmitting radio

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

ReceiverPdu

public ReceiverPdu()

Constructor creates and configures a new instance object

Method Details

copy

public ReceiverPdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public ReceiverPdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public ReceiverPdu 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 ReceiverPdu 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

setReceiverState

public ReceiverPdu setReceiverState(ReceiverReceiverState pReceiverState)

Setter for receiverState

Parameters:

pReceiverState - new value of interest

Returns:

same object to permit progressive setters

getReceiverState

public ReceiverReceiverState getReceiverState()

Getter for receiverState

Returns:

value of interest

setPadding1

public ReceiverPdu setPadding1(short pPadding1)

Setter for padding1

Parameters:

pPadding1 - new value of interest

Returns:

same object to permit progressive setters

setPadding1

public ReceiverPdu setPadding1(int pPadding1)

Utility setter for padding1

Parameters:

pPadding1 - new value of interest

Returns:

same object to permit progressive setters

getPadding1

public short getPadding1()

Getter for padding1

Returns:

value of interest

setReceivedPower

public ReceiverPdu setReceivedPower(float pReceivedPower)

Setter for receivedPower

Parameters:

pReceivedPower - new value of interest

Returns:

same object to permit progressive setters

getReceivedPower

public float getReceivedPower()

Getter for receivedPower

Returns:

value of interest

setTransmitterEntityId

public ReceiverPdu setTransmitterEntityId(EntityID pTransmitterEntityId)

Setter for transmitterEntityId

Parameters:

pTransmitterEntityId - new value of interest

Returns:

same object to permit progressive setters

getTransmitterEntityId

public EntityID getTransmitterEntityId()

Getter for transmitterEntityId

Returns:

value of interest

setTransmitterRadioId

public ReceiverPdu setTransmitterRadioId(short pTransmitterRadioId)

Setter for transmitterRadioId

Parameters:

pTransmitterRadioId - new value of interest

Returns:

same object to permit progressive setters

setTransmitterRadioId

public ReceiverPdu setTransmitterRadioId(int pTransmitterRadioId)

Utility setter for transmitterRadioId

Parameters:

pTransmitterRadioId - new value of interest

Returns:

same object to permit progressive setters

getTransmitterRadioId

public short getTransmitterRadioId()

Getter for transmitterRadioId

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