Class DataRPdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.PduBase

edu.nps.moves.dis7.pdus.SimulationManagementWithReliabilityFamilyPdu

edu.nps.moves.dis7.pdus.DataRPdu

All Implemented Interfaces:

Marshaller, Serializable

Direct Known Subclasses:

DataReliablePdu

public class DataRPdu
extends SimulationManagementWithReliabilityFamilyPdu
implements Serializable

5.12.4.11 Serves the same function as the Data PDU but with the addition of reliability service levels and is used in response to a Data Query-R PDU, a Data-R PDU, or a Set Data-R PDU.

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 List<FixedDatum>	fixedDatumRecords	Fixed datum records
static final String	NAME	The name of this PDU type
protected int	numberOfFixedDatumRecords	Fixed datum record count
protected int	numberOfVariableDatumRecords	variable datum record count
protected byte	pad1	padding
protected short	pad2	padding
protected int	requestID	Request ID provides a unique identifier
protected RequiredReliabilityService	requiredReliabilityService	level of reliability service used for this transaction uid 74
protected List<VariableDatum>	variableDatumRecords	Variable datum records

Fields inherited from class edu.nps.moves.dis7.pdus.SimulationManagementWithReliabilityFamilyPdu

FAMILY_NAME, originatingID, receivingID

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

Method Summary

Modifier and Type	Method	Description
DataRPdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
DataRPdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
DataRPdu	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
List<FixedDatum>	getFixedDatumRecords()	Getter for fixedDatumRecords
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
byte	getPad1()	Getter for pad1
short	getPad2()	Getter for pad2
int	getRequestID()	Getter for requestID
RequiredReliabilityService	getRequiredReliabilityService()	Getter for requiredReliabilityService
List<VariableDatum>	getVariableDatumRecords()	Getter for variableDatumRecords
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
DataRPdu	setFixedDatumRecords(List<FixedDatum> pFixedDatumRecords)	Setter for fixedDatumRecords
DataRPdu	setPad1(byte pPad1)	Setter for pad1
DataRPdu	setPad1(int pPad1)	Utility setter for pad1
DataRPdu	setPad2(int pPad2)	Utility setter for pad2
DataRPdu	setPad2(short pPad2)	Setter for pad2
DataRPdu	setRequestID(int pRequestID)	Setter for requestID
DataRPdu	setRequiredReliabilityService(RequiredReliabilityService pRequiredReliabilityService)	Setter for requiredReliabilityService
DataRPdu	setVariableDatumRecords(List<VariableDatum> pVariableDatumRecords)	Setter for variableDatumRecords
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.SimulationManagementWithReliabilityFamilyPdu

getOriginatingID, getReceivingID, setOriginatingID, setReceivingID

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

requestID

protected int requestID

Request ID provides a unique identifier

requiredReliabilityService

protected RequiredReliabilityService requiredReliabilityService

level of reliability service used for this transaction uid 74

pad1

protected byte pad1

padding

pad2

protected short pad2

padding

numberOfFixedDatumRecords

protected int numberOfFixedDatumRecords

Fixed datum record count

numberOfVariableDatumRecords

protected int numberOfVariableDatumRecords

variable datum record count

fixedDatumRecords

protected List<FixedDatum> fixedDatumRecords

Fixed datum records

variableDatumRecords

protected List<VariableDatum> variableDatumRecords

Variable datum records

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

DataRPdu

public DataRPdu()

Constructor creates and configures a new instance object

Method Details

copy

public DataRPdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public DataRPdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public DataRPdu 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 SimulationManagementWithReliabilityFamilyPdu

Returns:

serialized size in bytes

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

setRequestID

public DataRPdu setRequestID(int pRequestID)

Setter for requestID

Parameters:

pRequestID - new value of interest

Returns:

same object to permit progressive setters

getRequestID

public int getRequestID()

Getter for requestID

Returns:

value of interest

setRequiredReliabilityService

public DataRPdu setRequiredReliabilityService(RequiredReliabilityService pRequiredReliabilityService)

Setter for requiredReliabilityService

Parameters:

pRequiredReliabilityService - new value of interest

Returns:

same object to permit progressive setters

getRequiredReliabilityService

public RequiredReliabilityService getRequiredReliabilityService()

Getter for requiredReliabilityService

Returns:

value of interest

setPad1

public DataRPdu setPad1(byte pPad1)

Setter for pad1

Parameters:

pPad1 - new value of interest

Returns:

same object to permit progressive setters

setPad1

public DataRPdu setPad1(int pPad1)

Utility setter for pad1

Parameters:

pPad1 - new value of interest

Returns:

same object to permit progressive setters

getPad1

public byte getPad1()

Getter for pad1

Returns:

value of interest

setPad2

public DataRPdu setPad2(short pPad2)

Setter for pad2

Parameters:

pPad2 - new value of interest

Returns:

same object to permit progressive setters

setPad2

public DataRPdu setPad2(int pPad2)

Utility setter for pad2

Parameters:

pPad2 - new value of interest

Returns:

same object to permit progressive setters

getPad2

public short getPad2()

Getter for pad2

Returns:

value of interest

setFixedDatumRecords

public DataRPdu setFixedDatumRecords(List<FixedDatum> pFixedDatumRecords)

Setter for fixedDatumRecords

Parameters:

pFixedDatumRecords - new value of interest

Returns:

same object to permit progressive setters

getFixedDatumRecords

public List<FixedDatum> getFixedDatumRecords()

Getter for fixedDatumRecords

Returns:

value of interest

setVariableDatumRecords

public DataRPdu setVariableDatumRecords(List<VariableDatum> pVariableDatumRecords)

Setter for variableDatumRecords

Parameters:

pVariableDatumRecords - new value of interest

Returns:

same object to permit progressive setters

getVariableDatumRecords

public List<VariableDatum> getVariableDatumRecords()

Getter for variableDatumRecords

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 SimulationManagementWithReliabilityFamilyPdu

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 SimulationManagementWithReliabilityFamilyPdu

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 SimulationManagementWithReliabilityFamilyPdu

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 SimulationManagementWithReliabilityFamilyPdu

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 SimulationManagementWithReliabilityFamilyPdu

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 SimulationManagementWithReliabilityFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class SimulationManagementWithReliabilityFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class SimulationManagementWithReliabilityFamilyPdu