Class ResupplyReceivedPdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.PduBase

edu.nps.moves.dis7.pdus.LogisticsFamilyPdu

edu.nps.moves.dis7.pdus.ResupplyReceivedPdu

All Implemented Interfaces:

Marshaller, Serializable

public class ResupplyReceivedPdu
extends LogisticsFamilyPdu
implements Serializable

5.5.7 Used to acknowledge the receipt of supplies by the receiving entity.

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 byte	numberOfSupplyTypes	How many supplies are taken by receiving entity
protected byte	padding1	padding
protected short	padding2	padding
protected EntityID	receivingEntityID	Entity that is receiving service.
protected List<SupplyQuantity>	supplies	A Reord that Specifies the type of supply and the amount of that supply for each of the supply types in numberOfSupplyTypes (see 6.2.85), Section 7.4.3
protected EntityID	supplyingEntityID	Entity that is supplying.

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

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

Method Summary

Modifier and Type	Method	Description
ResupplyReceivedPdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
ResupplyReceivedPdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
ResupplyReceivedPdu	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	getPadding1()	Getter for padding1
short	getPadding2()	Getter for padding2
EntityID	getReceivingEntityID()	Getter for receivingEntityID
List<SupplyQuantity>	getSupplies()	Getter for supplies
EntityID	getSupplyingEntityID()	Getter for supplyingEntityID
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
ResupplyReceivedPdu	setPadding1(byte pPadding1)	Setter for padding1
ResupplyReceivedPdu	setPadding1(int pPadding1)	Utility setter for padding1
ResupplyReceivedPdu	setPadding2(int pPadding2)	Utility setter for padding2
ResupplyReceivedPdu	setPadding2(short pPadding2)	Setter for padding2
ResupplyReceivedPdu	setReceivingEntityID(EntityID pReceivingEntityID)	Setter for receivingEntityID
ResupplyReceivedPdu	setSupplies(List<SupplyQuantity> pSupplies)	Setter for supplies
ResupplyReceivedPdu	setSupplyingEntityID(EntityID pSupplyingEntityID)	Setter for supplyingEntityID
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

receivingEntityID

protected EntityID receivingEntityID

Entity that is receiving service. Shall be represented by Entity Identifier record (see 6.2.28)

supplyingEntityID

protected EntityID supplyingEntityID

Entity that is supplying. Shall be represented by Entity Identifier record (see 6.2.28)

numberOfSupplyTypes

protected byte numberOfSupplyTypes

How many supplies are taken by receiving entity

padding1

protected byte padding1

padding

padding2

protected short padding2

padding

supplies

protected List<SupplyQuantity> supplies

A Reord that Specifies the type of supply and the amount of that supply for each of the supply types in numberOfSupplyTypes (see 6.2.85), Section 7.4.3

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

ResupplyReceivedPdu

public ResupplyReceivedPdu()

Constructor creates and configures a new instance object

Method Details

copy

public ResupplyReceivedPdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public ResupplyReceivedPdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public ResupplyReceivedPdu 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 LogisticsFamilyPdu

Returns:

serialized size in bytes

See Also:

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

setReceivingEntityID

public ResupplyReceivedPdu setReceivingEntityID(EntityID pReceivingEntityID)

Setter for receivingEntityID

Parameters:

pReceivingEntityID - new value of interest

Returns:

same object to permit progressive setters

getReceivingEntityID

public EntityID getReceivingEntityID()

Getter for receivingEntityID

Returns:

value of interest

setSupplyingEntityID

public ResupplyReceivedPdu setSupplyingEntityID(EntityID pSupplyingEntityID)

Setter for supplyingEntityID

Parameters:

pSupplyingEntityID - new value of interest

Returns:

same object to permit progressive setters

getSupplyingEntityID

public EntityID getSupplyingEntityID()

Getter for supplyingEntityID

Returns:

value of interest

setPadding1

public ResupplyReceivedPdu setPadding1(byte pPadding1)

Setter for padding1

Parameters:

pPadding1 - new value of interest

Returns:

same object to permit progressive setters

setPadding1

public ResupplyReceivedPdu setPadding1(int pPadding1)

Utility setter for padding1

Parameters:

pPadding1 - new value of interest

Returns:

same object to permit progressive setters

getPadding1

public byte getPadding1()

Getter for padding1

Returns:

value of interest

setPadding2

public ResupplyReceivedPdu setPadding2(short pPadding2)

Setter for padding2

Parameters:

pPadding2 - new value of interest

Returns:

same object to permit progressive setters

setPadding2

public ResupplyReceivedPdu setPadding2(int pPadding2)

Utility setter for padding2

Parameters:

pPadding2 - new value of interest

Returns:

same object to permit progressive setters

getPadding2

public short getPadding2()

Getter for padding2

Returns:

value of interest

setSupplies

public ResupplyReceivedPdu setSupplies(List<SupplyQuantity> pSupplies)

Setter for supplies

Parameters:

pSupplies - new value of interest

Returns:

same object to permit progressive setters

getSupplies

public List<SupplyQuantity> getSupplies()

Getter for supplies

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 LogisticsFamilyPdu

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 LogisticsFamilyPdu

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 LogisticsFamilyPdu

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 LogisticsFamilyPdu

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 LogisticsFamilyPdu

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 LogisticsFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class LogisticsFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class PduBase