Class EntityDamageStatusPdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.PduBase

edu.nps.moves.dis7.pdus.WarfareFamilyPdu

edu.nps.moves.dis7.pdus.EntityDamageStatusPdu

All Implemented Interfaces:

Marshaller, Serializable

public class EntityDamageStatusPdu
extends WarfareFamilyPdu
implements Serializable

7.3.5 Used to communicate detailed damage information sustained by an entity regardless of the source of the damage.

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 EntityID	damagedEntityID	Field shall identify the damaged entity (see 6.2.28), Section 7.3.4
protected List<DirectedEnergyDamage>	damageDescriptionRecords	Fields shall contain one or more Damage Description records (see 6.2.17) and may contain other Standard Variable records, Section 7.3.5
protected DataOutputStream	dataOutputStream	dataOutputStream (dos) is used for marshal/unmarshal serialization
static final String	NAME	The name of this PDU type
protected short	numberOfDamageDescription	field shall specify the number of Damage Description records, Section 7.3.5
protected short	padding1	padding1 is an undescribed parameter...
protected short	padding2	padding2 is an undescribed parameter...

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

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

Method Summary

Modifier and Type	Method	Description
EntityDamageStatusPdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
EntityDamageStatusPdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
EntityDamageStatusPdu	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
EntityID	getDamagedEntityID()	Getter for damagedEntityID
List<DirectedEnergyDamage>	getDamageDescriptionRecords()	Getter for damageDescriptionRecords
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
short	getPadding1()	Getter for padding1
short	getPadding2()	Getter for padding2
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
EntityDamageStatusPdu	setDamagedEntityID(EntityID pDamagedEntityID)	Setter for damagedEntityID
EntityDamageStatusPdu	setDamageDescriptionRecords(List<DirectedEnergyDamage> pDamageDescriptionRecords)	Setter for damageDescriptionRecords
EntityDamageStatusPdu	setPadding1(int pPadding1)	Utility setter for padding1
EntityDamageStatusPdu	setPadding1(short pPadding1)	Setter for padding1
EntityDamageStatusPdu	setPadding2(int pPadding2)	Utility setter for padding2
EntityDamageStatusPdu	setPadding2(short pPadding2)	Setter for padding2
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

damagedEntityID

protected EntityID damagedEntityID

Field shall identify the damaged entity (see 6.2.28), Section 7.3.4

padding1

protected short padding1

padding1 is an undescribed parameter...

padding2

protected short padding2

padding2 is an undescribed parameter...

numberOfDamageDescription

protected short numberOfDamageDescription

field shall specify the number of Damage Description records, Section 7.3.5

damageDescriptionRecords

protected List<DirectedEnergyDamage> damageDescriptionRecords

Fields shall contain one or more Damage Description records (see 6.2.17) and may contain other Standard Variable records, Section 7.3.5

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

EntityDamageStatusPdu

public EntityDamageStatusPdu()

Constructor creates and configures a new instance object

Method Details

copy

public EntityDamageStatusPdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public EntityDamageStatusPdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public EntityDamageStatusPdu 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 WarfareFamilyPdu

Returns:

serialized size in bytes

See Also:

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

setDamagedEntityID

public EntityDamageStatusPdu setDamagedEntityID(EntityID pDamagedEntityID)

Setter for damagedEntityID

Parameters:

pDamagedEntityID - new value of interest

Returns:

same object to permit progressive setters

getDamagedEntityID

public EntityID getDamagedEntityID()

Getter for damagedEntityID

Returns:

value of interest

setPadding1

public EntityDamageStatusPdu setPadding1(short pPadding1)

Setter for padding1

Parameters:

pPadding1 - new value of interest

Returns:

same object to permit progressive setters

setPadding1

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

setPadding2

public EntityDamageStatusPdu setPadding2(short pPadding2)

Setter for padding2

Parameters:

pPadding2 - new value of interest

Returns:

same object to permit progressive setters

setPadding2

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

setDamageDescriptionRecords

public EntityDamageStatusPdu setDamageDescriptionRecords(List<DirectedEnergyDamage> pDamageDescriptionRecords)

Setter for damageDescriptionRecords

Parameters:

pDamageDescriptionRecords - new value of interest

Returns:

same object to permit progressive setters

getDamageDescriptionRecords

public List<DirectedEnergyDamage> getDamageDescriptionRecords()

Getter for damageDescriptionRecords

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 WarfareFamilyPdu

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 WarfareFamilyPdu

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 WarfareFamilyPdu

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 WarfareFamilyPdu

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 WarfareFamilyPdu

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 WarfareFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class WarfareFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class PduBase