Class DetonationPdu

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

All Implemented Interfaces:

Marshaller, Serializable

public class DetonationPdu
extends WarfareFamilyPdu
implements Serializable

7.3.3 Used to communicate the detonation or impact of munitions, as well as non-munition explosions, the burst or initial bloom of chaff, and the ignition of a flare.

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 MunitionDescriptor	descriptor	Describes the detonation represented, Section 7.3.3
protected DetonationResult	detonationResult	result of the detonation, Section 7.3.3 uid 62
protected EventIdentifier	eventID	ID of event, Section 7.3.3
protected EntityID	explodingEntityID	ID of the expendable entity, Section 7.3.3
protected Vector3Double	locationInWorldCoordinates	location of the munition detonation, the expendable detonation, Section 7.3.3
protected Vector3Float	locationOfEntityCoordinates	Velocity of the ammunition, Section 7.3.3
static final String	NAME	The name of this PDU type
protected byte	numberOfVariableParameters	How many articulation parameters we have, Section 7.3.3
protected short	pad	padding
protected EntityID	sourceEntityID	ID of the entity that shot
protected EntityID	targetEntityID	ID of the entity that is being shot at
protected List<VariableParameter>	variableParameters	specify the parameter values for each Variable Parameter record, Section 7.3.3
protected Vector3Float	velocity	velocity of the munition immediately before detonation/impact, Section 7.3.3

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

Method Summary

Modifier and Type	Method	Description
DetonationPdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
DetonationPdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
DetonationPdu	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
MunitionDescriptor	getDescriptor()	Getter for descriptor
DetonationResult	getDetonationResult()	Getter for detonationResult
EventIdentifier	getEventID()	Getter for eventID
EntityID	getExplodingEntityID()	Getter for explodingEntityID
Vector3Double	getLocationInWorldCoordinates()	Getter for locationInWorldCoordinates
Vector3Float	getLocationOfEntityCoordinates()	Getter for locationOfEntityCoordinates
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
short	getPad()	Getter for pad
EntityID	getSourceEntityID()	Getter for sourceEntityID
EntityID	getTargetEntityID()	Getter for targetEntityID
List<VariableParameter>	getVariableParameters()	Getter for variableParameters
Vector3Float	getVelocity()	Getter for velocity
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
DetonationPdu	setDescriptor(MunitionDescriptor pDescriptor)	Setter for descriptor
DetonationPdu	setDetonationResult(DetonationResult pDetonationResult)	Setter for detonationResult
DetonationPdu	setEventID(EventIdentifier pEventID)	Setter for eventID
DetonationPdu	setExplodingEntityID(EntityID pExplodingEntityID)	Setter for explodingEntityID
DetonationPdu	setLocationInWorldCoordinates(Vector3Double pLocationInWorldCoordinates)	Setter for locationInWorldCoordinates
DetonationPdu	setLocationOfEntityCoordinates(Vector3Float pLocationOfEntityCoordinates)	Setter for locationOfEntityCoordinates
DetonationPdu	setPad(int pPad)	Utility setter for pad
DetonationPdu	setPad(short pPad)	Setter for pad
DetonationPdu	setSourceEntityID(EntityID pSourceEntityID)	Setter for sourceEntityID
DetonationPdu	setTargetEntityID(EntityID pTargetEntityID)	Setter for targetEntityID
DetonationPdu	setVariableParameters(List<VariableParameter> pVariableParameters)	Setter for variableParameters
DetonationPdu	setVelocity(Vector3Float pVelocity)	Setter for velocity
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

sourceEntityID

protected EntityID sourceEntityID

ID of the entity that shot

targetEntityID

protected EntityID targetEntityID

ID of the entity that is being shot at

explodingEntityID

protected EntityID explodingEntityID

ID of the expendable entity, Section 7.3.3

eventID

protected EventIdentifier eventID

ID of event, Section 7.3.3

velocity

protected Vector3Float velocity

velocity of the munition immediately before detonation/impact, Section 7.3.3

locationInWorldCoordinates

protected Vector3Double locationInWorldCoordinates

location of the munition detonation, the expendable detonation, Section 7.3.3

descriptor

protected MunitionDescriptor descriptor

Describes the detonation represented, Section 7.3.3

locationOfEntityCoordinates

protected Vector3Float locationOfEntityCoordinates

Velocity of the ammunition, Section 7.3.3

detonationResult

protected DetonationResult detonationResult

result of the detonation, Section 7.3.3 uid 62

numberOfVariableParameters

protected byte numberOfVariableParameters

How many articulation parameters we have, Section 7.3.3

pad

protected short pad

padding

variableParameters

protected List<VariableParameter> variableParameters

specify the parameter values for each Variable Parameter record, Section 7.3.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

DetonationPdu

public DetonationPdu()

Constructor creates and configures a new instance object

Method Details

copy

public DetonationPdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public DetonationPdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public DetonationPdu 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)

setSourceEntityID

public DetonationPdu setSourceEntityID(EntityID pSourceEntityID)

Setter for sourceEntityID

Parameters:

pSourceEntityID - new value of interest

Returns:

same object to permit progressive setters

getSourceEntityID

public EntityID getSourceEntityID()

Getter for sourceEntityID

Returns:

value of interest

setTargetEntityID

public DetonationPdu setTargetEntityID(EntityID pTargetEntityID)

Setter for targetEntityID

Parameters:

pTargetEntityID - new value of interest

Returns:

same object to permit progressive setters

getTargetEntityID

public EntityID getTargetEntityID()

Getter for targetEntityID

Returns:

value of interest

setExplodingEntityID

public DetonationPdu setExplodingEntityID(EntityID pExplodingEntityID)

Setter for explodingEntityID

Parameters:

pExplodingEntityID - new value of interest

Returns:

same object to permit progressive setters

getExplodingEntityID

public EntityID getExplodingEntityID()

Getter for explodingEntityID

Returns:

value of interest

setEventID

public DetonationPdu setEventID(EventIdentifier pEventID)

Setter for eventID

Parameters:

pEventID - new value of interest

Returns:

same object to permit progressive setters

getEventID

public EventIdentifier getEventID()

Getter for eventID

Returns:

value of interest

setVelocity

public DetonationPdu setVelocity(Vector3Float pVelocity)

Setter for velocity

Parameters:

pVelocity - new value of interest

Returns:

same object to permit progressive setters

getVelocity

public Vector3Float getVelocity()

Getter for velocity

Returns:

value of interest

setLocationInWorldCoordinates

public DetonationPdu setLocationInWorldCoordinates(Vector3Double pLocationInWorldCoordinates)

Setter for locationInWorldCoordinates

Parameters:

pLocationInWorldCoordinates - new value of interest

Returns:

same object to permit progressive setters

getLocationInWorldCoordinates

public Vector3Double getLocationInWorldCoordinates()

Getter for locationInWorldCoordinates

Returns:

value of interest

setDescriptor

public DetonationPdu setDescriptor(MunitionDescriptor pDescriptor)

Setter for descriptor

Parameters:

pDescriptor - new value of interest

Returns:

same object to permit progressive setters

getDescriptor

public MunitionDescriptor getDescriptor()

Getter for descriptor

Returns:

value of interest

setLocationOfEntityCoordinates

public DetonationPdu setLocationOfEntityCoordinates(Vector3Float pLocationOfEntityCoordinates)

Setter for locationOfEntityCoordinates

Parameters:

pLocationOfEntityCoordinates - new value of interest

Returns:

same object to permit progressive setters

getLocationOfEntityCoordinates

public Vector3Float getLocationOfEntityCoordinates()

Getter for locationOfEntityCoordinates

Returns:

value of interest

setDetonationResult

public DetonationPdu setDetonationResult(DetonationResult pDetonationResult)

Setter for detonationResult

Parameters:

pDetonationResult - new value of interest

Returns:

same object to permit progressive setters

getDetonationResult

public DetonationResult getDetonationResult()

Getter for detonationResult

Returns:

value of interest

setPad

public DetonationPdu setPad(short pPad)

Setter for pad

Parameters:

pPad - new value of interest

Returns:

same object to permit progressive setters

setPad

public DetonationPdu setPad(int pPad)

Utility setter for pad

Parameters:

pPad - new value of interest

Returns:

same object to permit progressive setters

getPad

public short getPad()

Getter for pad

Returns:

value of interest

setVariableParameters

public DetonationPdu setVariableParameters(List<VariableParameter> pVariableParameters)

Setter for variableParameters

Parameters:

pVariableParameters - new value of interest

Returns:

same object to permit progressive setters

getVariableParameters

public List<VariableParameter> getVariableParameters()

Getter for variableParameters

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