Package edu.nps.moves.dis7.pdus
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
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected ByteArrayOutputStreambyteArrayOutputStream (baos) is used for marshal/unmarshal serializationprotected DataOutputStreamdataOutputStream (dos) is used for marshal/unmarshal serializationprotected RadioCommsHeaderheader is an undescribed parameter...protected shortpadding1 is an undescribed parameter...protected floatreceived powerprotected ReceiverReceiverStateencoding scheme used, and enumeration uid 179protected EntityIDID of transmitterprotected shortID of transmitting radioFields 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 forheaderintReturns size of this serialized (marshalled) object in bytesshortGetter forpadding1floatGetter forreceivedPowerGetter forreceiverStateGetter fortransmitterEntityIdshortGetter fortransmitterRadioIdvoidmarshal(DataOutputStream dos) Serializes an object to a DataOutputStream.voidmarshal(ByteBuffer byteBuffer) Packs an object into the ByteBuffer.setHeader(RadioCommsHeader pHeader) Setter forheadersetPadding1(int pPadding1) Utility setter forpadding1setPadding1(short pPadding1) Setter forpadding1setReceivedPower(float pReceivedPower) Setter forreceivedPowersetReceiverState(ReceiverReceiverState pReceiverState) Setter forreceiverStatesetTransmitterEntityId(EntityID pTransmitterEntityId) Setter fortransmitterEntityIdsetTransmitterRadioId(int pTransmitterRadioId) Utility setter fortransmitterRadioIdsetTransmitterRadioId(short pTransmitterRadioId) Setter fortransmitterRadioIdtoString()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... -
receiverState
encoding scheme used, and enumeration uid 179 -
padding1
protected short padding1padding1 is an undescribed parameter... -
receivedPower
protected float receivedPowerreceived power -
transmitterEntityId
ID of transmitter -
transmitterRadioId
protected short transmitterRadioIdID of transmitting radio -
byteArrayOutputStream
byteArrayOutputStream (baos) is used for marshal/unmarshal serialization- See Also:
-
dataOutputStream
dataOutputStream (dos) is used for marshal/unmarshal serialization- See Also:
-
-
Constructor Details
-
ReceiverPdu
public ReceiverPdu()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
-
setReceiverState
Setter forreceiverState- Parameters:
pReceiverState- new value of interest- Returns:
- same object to permit progressive setters
-
getReceiverState
Getter forreceiverState- 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 short getPadding1()Getter forpadding1- Returns:
- value of interest
-
setReceivedPower
Setter forreceivedPower- Parameters:
pReceivedPower- new value of interest- Returns:
- same object to permit progressive setters
-
getReceivedPower
public float getReceivedPower()Getter forreceivedPower- Returns:
- value of interest
-
setTransmitterEntityId
Setter fortransmitterEntityId- Parameters:
pTransmitterEntityId- new value of interest- Returns:
- same object to permit progressive setters
-
getTransmitterEntityId
Getter fortransmitterEntityId- Returns:
- value of interest
-
setTransmitterRadioId
Setter fortransmitterRadioId- Parameters:
pTransmitterRadioId- new value of interest- Returns:
- same object to permit progressive setters
-
setTransmitterRadioId
Utility setter fortransmitterRadioId- Parameters:
pTransmitterRadioId- new value of interest- Returns:
- same object to permit progressive setters
-
getTransmitterRadioId
public short getTransmitterRadioId()Getter fortransmitterRadioId- 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
-