Class LEDetonationPdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.LiveEntityFamilyPdu

edu.nps.moves.dis7.pdus.LEDetonationPdu

All Implemented Interfaces:

Marshaller, Serializable

Direct Known Subclasses:

LiveEntityDetonationPdu

public class LEDetonationPdu
extends LiveEntityFamilyPdu
implements Serializable

9.4.6 Communicate information associated with the impact or detonation of a munition.

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 byte	detonationFlag1	detonationFlag1 is an undescribed parameter...
protected byte	detonationFlag2	detonationFlag2 is an undescribed parameter...
protected byte	detonationResult	detonationResult is an undescribed parameter...
protected LiveEntityLinearVelocity	entityLocation	entityLocation is an undescribed parameter...
protected EventIdentifier	eventId	eventId is an undescribed parameter...
protected EntityID	firingLiveEntityId	firingLiveEntityId is an undescribed parameter...
protected MunitionDescriptor	munitionDescriptor	munitionDescriptor is an undescribed parameter...
protected EntityID	munitionLiveEntityId	munitionLiveEntityId is an undescribed parameter...
protected LiveEntityOrientation16	munitionOrientation	spec error?
static final String	NAME	The name of this PDU type
protected EntityID	targetLiveEntityId	targetLiveEntityId is an undescribed parameter...
protected LiveEntityLinearVelocity	velocity	velocity is an undescribed parameter...
protected LiveEntityRelativeWorldCoordinates	worldLocation	worldLocation is an undescribed parameter...

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

FAMILY_NAME

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

exerciseID, length, pduType, protocolFamily, protocolVersion, timestamp

Constructor Summary

Constructors

Constructor	Description
LEDetonationPdu()	Constructor creates and configures a new instance object

Method Summary

Modifier and Type	Method	Description
LEDetonationPdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
LEDetonationPdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
LEDetonationPdu	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
byte	getDetonationFlag1()	Getter for detonationFlag1
byte	getDetonationFlag2()	Getter for detonationFlag2
byte	getDetonationResult()	Getter for detonationResult
LiveEntityLinearVelocity	getEntityLocation()	Getter for entityLocation
EventIdentifier	getEventId()	Getter for eventId
EntityID	getFiringLiveEntityId()	Getter for firingLiveEntityId
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
MunitionDescriptor	getMunitionDescriptor()	Getter for munitionDescriptor
EntityID	getMunitionLiveEntityId()	Getter for munitionLiveEntityId
LiveEntityOrientation16	getMunitionOrientation()	Getter for munitionOrientation
EntityID	getTargetLiveEntityId()	Getter for targetLiveEntityId
LiveEntityLinearVelocity	getVelocity()	Getter for velocity
LiveEntityRelativeWorldCoordinates	getWorldLocation()	Getter for worldLocation
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
LEDetonationPdu	setDetonationFlag1(byte pDetonationFlag1)	Setter for detonationFlag1
LEDetonationPdu	setDetonationFlag1(int pDetonationFlag1)	Utility setter for detonationFlag1
LEDetonationPdu	setDetonationFlag2(byte pDetonationFlag2)	Setter for detonationFlag2
LEDetonationPdu	setDetonationFlag2(int pDetonationFlag2)	Utility setter for detonationFlag2
LEDetonationPdu	setDetonationResult(byte pDetonationResult)	Setter for detonationResult
LEDetonationPdu	setDetonationResult(int pDetonationResult)	Utility setter for detonationResult
LEDetonationPdu	setEntityLocation(LiveEntityLinearVelocity pEntityLocation)	Setter for entityLocation
LEDetonationPdu	setEventId(EventIdentifier pEventId)	Setter for eventId
LEDetonationPdu	setFiringLiveEntityId(EntityID pFiringLiveEntityId)	Setter for firingLiveEntityId
LEDetonationPdu	setMunitionDescriptor(MunitionDescriptor pMunitionDescriptor)	Setter for munitionDescriptor
LEDetonationPdu	setMunitionLiveEntityId(EntityID pMunitionLiveEntityId)	Setter for munitionLiveEntityId
LEDetonationPdu	setMunitionOrientation(LiveEntityOrientation16 pMunitionOrientation)	Setter for munitionOrientation
LEDetonationPdu	setTargetLiveEntityId(EntityID pTargetLiveEntityId)	Setter for targetLiveEntityId
LEDetonationPdu	setVelocity(LiveEntityLinearVelocity pVelocity)	Setter for velocity
LEDetonationPdu	setWorldLocation(LiveEntityRelativeWorldCoordinates pWorldLocation)	Setter for worldLocation
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.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

firingLiveEntityId

protected EntityID firingLiveEntityId

firingLiveEntityId is an undescribed parameter...

detonationFlag1

protected byte detonationFlag1

detonationFlag1 is an undescribed parameter...

detonationFlag2

protected byte detonationFlag2

detonationFlag2 is an undescribed parameter...

targetLiveEntityId

protected EntityID targetLiveEntityId

targetLiveEntityId is an undescribed parameter...

munitionLiveEntityId

protected EntityID munitionLiveEntityId

munitionLiveEntityId is an undescribed parameter...

eventId

protected EventIdentifier eventId

eventId is an undescribed parameter...

worldLocation

protected LiveEntityRelativeWorldCoordinates worldLocation

worldLocation is an undescribed parameter...

velocity

protected LiveEntityLinearVelocity velocity

velocity is an undescribed parameter...

munitionOrientation

protected LiveEntityOrientation16 munitionOrientation

spec error? 16-bit fields vs. 8-bit in TspiPdu?

munitionDescriptor

protected MunitionDescriptor munitionDescriptor

munitionDescriptor is an undescribed parameter...

entityLocation

protected LiveEntityLinearVelocity entityLocation

entityLocation is an undescribed parameter...

detonationResult

protected byte detonationResult

detonationResult is an undescribed parameter...

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

LEDetonationPdu

public LEDetonationPdu()

Constructor creates and configures a new instance object

Method Details

copy

public LEDetonationPdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public LEDetonationPdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public LEDetonationPdu 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 LiveEntityFamilyPdu

Returns:

serialized size in bytes

See Also:

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

setFiringLiveEntityId

public LEDetonationPdu setFiringLiveEntityId(EntityID pFiringLiveEntityId)

Setter for firingLiveEntityId

Parameters:

pFiringLiveEntityId - new value of interest

Returns:

same object to permit progressive setters

getFiringLiveEntityId

public EntityID getFiringLiveEntityId()

Getter for firingLiveEntityId

Returns:

value of interest

setDetonationFlag1

public LEDetonationPdu setDetonationFlag1(byte pDetonationFlag1)

Setter for detonationFlag1

Parameters:

pDetonationFlag1 - new value of interest

Returns:

same object to permit progressive setters

setDetonationFlag1

public LEDetonationPdu setDetonationFlag1(int pDetonationFlag1)

Utility setter for detonationFlag1

Parameters:

pDetonationFlag1 - new value of interest

Returns:

same object to permit progressive setters

getDetonationFlag1

public byte getDetonationFlag1()

Getter for detonationFlag1

Returns:

value of interest

setDetonationFlag2

public LEDetonationPdu setDetonationFlag2(byte pDetonationFlag2)

Setter for detonationFlag2

Parameters:

pDetonationFlag2 - new value of interest

Returns:

same object to permit progressive setters

setDetonationFlag2

public LEDetonationPdu setDetonationFlag2(int pDetonationFlag2)

Utility setter for detonationFlag2

Parameters:

pDetonationFlag2 - new value of interest

Returns:

same object to permit progressive setters

getDetonationFlag2

public byte getDetonationFlag2()

Getter for detonationFlag2

Returns:

value of interest

setTargetLiveEntityId

public LEDetonationPdu setTargetLiveEntityId(EntityID pTargetLiveEntityId)

Setter for targetLiveEntityId

Parameters:

pTargetLiveEntityId - new value of interest

Returns:

same object to permit progressive setters

getTargetLiveEntityId

public EntityID getTargetLiveEntityId()

Getter for targetLiveEntityId

Returns:

value of interest

setMunitionLiveEntityId

public LEDetonationPdu setMunitionLiveEntityId(EntityID pMunitionLiveEntityId)

Setter for munitionLiveEntityId

Parameters:

pMunitionLiveEntityId - new value of interest

Returns:

same object to permit progressive setters

getMunitionLiveEntityId

public EntityID getMunitionLiveEntityId()

Getter for munitionLiveEntityId

Returns:

value of interest

setEventId

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

setWorldLocation

public LEDetonationPdu setWorldLocation(LiveEntityRelativeWorldCoordinates pWorldLocation)

Setter for worldLocation

Parameters:

pWorldLocation - new value of interest

Returns:

same object to permit progressive setters

getWorldLocation

public LiveEntityRelativeWorldCoordinates getWorldLocation()

Getter for worldLocation

Returns:

value of interest

setVelocity

public LEDetonationPdu setVelocity(LiveEntityLinearVelocity pVelocity)

Setter for velocity

Parameters:

pVelocity - new value of interest

Returns:

same object to permit progressive setters

getVelocity

public LiveEntityLinearVelocity getVelocity()

Getter for velocity

Returns:

value of interest

setMunitionOrientation

public LEDetonationPdu setMunitionOrientation(LiveEntityOrientation16 pMunitionOrientation)

Setter for munitionOrientation

Parameters:

pMunitionOrientation - new value of interest

Returns:

same object to permit progressive setters

getMunitionOrientation

public LiveEntityOrientation16 getMunitionOrientation()

Getter for munitionOrientation

Returns:

value of interest

setMunitionDescriptor

public LEDetonationPdu setMunitionDescriptor(MunitionDescriptor pMunitionDescriptor)

Setter for munitionDescriptor

Parameters:

pMunitionDescriptor - new value of interest

Returns:

same object to permit progressive setters

getMunitionDescriptor

public MunitionDescriptor getMunitionDescriptor()

Getter for munitionDescriptor

Returns:

value of interest

setEntityLocation

public LEDetonationPdu setEntityLocation(LiveEntityLinearVelocity pEntityLocation)

Setter for entityLocation

Parameters:

pEntityLocation - new value of interest

Returns:

same object to permit progressive setters

getEntityLocation

public LiveEntityLinearVelocity getEntityLocation()

Getter for entityLocation

Returns:

value of interest

setDetonationResult

public LEDetonationPdu setDetonationResult(byte pDetonationResult)

Setter for detonationResult

Parameters:

pDetonationResult - new value of interest

Returns:

same object to permit progressive setters

setDetonationResult

public LEDetonationPdu setDetonationResult(int pDetonationResult)

Utility setter for detonationResult

Parameters:

pDetonationResult - new value of interest

Returns:

same object to permit progressive setters

getDetonationResult

public byte getDetonationResult()

Getter for detonationResult

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 LiveEntityFamilyPdu

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 LiveEntityFamilyPdu

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 LiveEntityFamilyPdu

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 LiveEntityFamilyPdu

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 LiveEntityFamilyPdu

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 LiveEntityFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class LiveEntityFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class Pdu