Class SetRecordRPdu

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

All Implemented Interfaces:

Marshaller, Serializable

Direct Known Subclasses:

SetRecordReliablePdu

public class SetRecordRPdu
extends SimulationManagementWithReliabilityFamilyPdu
implements Serializable

5.12.4.15 Used to set or change certain parameter values. These parameter values are contained within a record format as compared to the datum format used in the 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
static final String	NAME	The name of this PDU type
protected int	numberOfRecordSets	Number of record sets in list
protected byte	pad1	pad1 is an undescribed parameter...
protected short	pad2	pad2 is an undescribed parameter...
protected int	pad3	pad3 is an undescribed parameter...
protected List<RecordSpecification>	recordSets	record sets
protected int	requestID	request ID provides a unique identifier
protected RequiredReliabilityService	requiredReliabilityService	level of reliability service used for this transaction uid 74

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

Method Summary

Modifier and Type	Method	Description
SetRecordRPdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
SetRecordRPdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
SetRecordRPdu	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
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
byte	getPad1()	Getter for pad1
short	getPad2()	Getter for pad2
int	getPad3()	Getter for pad3
List<RecordSpecification>	getRecordSets()	Getter for recordSets
int	getRequestID()	Getter for requestID
RequiredReliabilityService	getRequiredReliabilityService()	Getter for requiredReliabilityService
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
SetRecordRPdu	setPad1(byte pPad1)	Setter for pad1
SetRecordRPdu	setPad1(int pPad1)	Utility setter for pad1
SetRecordRPdu	setPad2(int pPad2)	Utility setter for pad2
SetRecordRPdu	setPad2(short pPad2)	Setter for pad2
SetRecordRPdu	setPad3(int pPad3)	Setter for pad3
SetRecordRPdu	setRecordSets(List<RecordSpecification> pRecordSets)	Setter for recordSets
SetRecordRPdu	setRequestID(int pRequestID)	Setter for requestID
SetRecordRPdu	setRequiredReliabilityService(RequiredReliabilityService pRequiredReliabilityService)	Setter for requiredReliabilityService
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

pad1 is an undescribed parameter...

pad2

protected short pad2

pad2 is an undescribed parameter...

pad3

protected int pad3

pad3 is an undescribed parameter...

numberOfRecordSets

protected int numberOfRecordSets

Number of record sets in list

recordSets

protected List<RecordSpecification> recordSets

record sets

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

SetRecordRPdu

public SetRecordRPdu()

Constructor creates and configures a new instance object

Method Details

copy

public SetRecordRPdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public SetRecordRPdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public SetRecordRPdu 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 SetRecordRPdu 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 SetRecordRPdu 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 SetRecordRPdu setPad1(byte pPad1)

Setter for pad1

Parameters:

pPad1 - new value of interest

Returns:

same object to permit progressive setters

setPad1

public SetRecordRPdu 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 SetRecordRPdu setPad2(short pPad2)

Setter for pad2

Parameters:

pPad2 - new value of interest

Returns:

same object to permit progressive setters

setPad2

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

setPad3

public SetRecordRPdu setPad3(int pPad3)

Setter for pad3

Parameters:

pPad3 - new value of interest

Returns:

same object to permit progressive setters

getPad3

public int getPad3()

Getter for pad3

Returns:

value of interest

setRecordSets

public SetRecordRPdu setRecordSets(List<RecordSpecification> pRecordSets)

Setter for recordSets

Parameters:

pRecordSets - new value of interest

Returns:

same object to permit progressive setters

getRecordSets

public List<RecordSpecification> getRecordSets()

Getter for recordSets

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