edu.nps.moves.dismobile
Class DetonationPdu

java.lang.Object
  extended by edu.nps.moves.dismobile.Pdu
      extended by edu.nps.moves.dismobile.WarfareFamilyPdu
          extended by edu.nps.moves.dismobile.DetonationPdu
All Implemented Interfaces:
java.io.Serializable

public class DetonationPdu
extends WarfareFamilyPdu
implements java.io.Serializable

Section 5.3.4.2. Information about stuff exploding. COMPLETE Copyright (c) 2008-2010, MOVES Institute, Naval Postgraduate School. All rights reserved. This work is licensed under the BSD open source license, available at https://www.movesinstitute.org/licenses/bsd.html

Author:
DMcG
See Also:
Serialized Form

Field Summary
protected  java.util.List<ArticulationParameter> articulationParameters
           
protected  BurstDescriptor burstDescriptor
          Describes munition used
protected  short detonationResult
          result of the explosion
protected  EventID eventID
          ID firing event
protected  Vector3Float locationInEntityCoordinates
          location of the detonation or impact in the target entity's coordinate system.
protected  Vector3Double locationInWorldCoordinates
          where the detonation is, in world coordinates
protected  EntityID munitionID
          ID of muntion that was fired
protected  short numberOfArticulationParameters
          How many articulation parameters we have
protected  short pad
          padding
protected  Vector3Float velocity
          ID firing event
 
Fields inherited from class edu.nps.moves.dismobile.WarfareFamilyPdu
firingEntityID, targetEntityID
 
Fields inherited from class edu.nps.moves.dismobile.Pdu
exerciseID, padding, pduLength, pduType, protocolFamily, protocolVersion, timestamp
 
Constructor Summary
DetonationPdu()
          Constructor
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 boolean equalsImpl(java.lang.Object obj)
          Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object
 java.util.List<ArticulationParameter> getArticulationParameters()
           
 BurstDescriptor getBurstDescriptor()
           
 short getDetonationResult()
           
 EventID getEventID()
           
 Vector3Float getLocationInEntityCoordinates()
           
 Vector3Double getLocationInWorldCoordinates()
           
 int getMarshalledSize()
           
 EntityID getMunitionID()
           
 short getNumberOfArticulationParameters()
           
 short getPad()
           
 Vector3Float getVelocity()
           
 void marshal(java.nio.ByteBuffer buff)
          Packs a Pdu into the ByteBuffer.
 void marshal(java.io.DataOutputStream dos)
           
 void setArticulationParameters(java.util.List<ArticulationParameter> pArticulationParameters)
           
 void setBurstDescriptor(BurstDescriptor pBurstDescriptor)
           
 void setDetonationResult(short pDetonationResult)
           
 void setEventID(EventID pEventID)
           
 void setLocationInEntityCoordinates(Vector3Float pLocationInEntityCoordinates)
           
 void setLocationInWorldCoordinates(Vector3Double pLocationInWorldCoordinates)
           
 void setMunitionID(EntityID pMunitionID)
           
 void setNumberOfArticulationParameters(short pNumberOfArticulationParameters)
          Note that setting this value will not change the marshalled value.
 void setPad(short pPad)
           
 void setVelocity(Vector3Float pVelocity)
           
 void unmarshal(java.nio.ByteBuffer buff)
          Unpacks a Pdu from the underlying data.
 void unmarshal(java.io.DataInputStream dis)
           
 
Methods inherited from class edu.nps.moves.dismobile.WarfareFamilyPdu
getFiringEntityID, getTargetEntityID, setFiringEntityID, setTargetEntityID
 
Methods inherited from class edu.nps.moves.dismobile.Pdu
getExerciseID, getLength, getPadding, getPduLength, getPduType, getProtocolFamily, getProtocolVersion, getTimestamp, marshal, marshalWithDisAbsoluteTimestamp, marshalWithDisAbsoluteTimestamp, marshalWithDisRelativeTimestamp, marshalWithDisRelativeTimestamp, marshalWithNpsTimestamp, marshalWithNpsTimestamp, marshalWithUnixTimestamp, marshalWithUnixTimestamp, readUnsignedInt, readUnsignedInt, setExerciseID, setPadding, setPduLength, setPduType, setProtocolFamily, setProtocolVersion, setTimestamp
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

munitionID

protected EntityID munitionID
ID of muntion that was fired


eventID

protected EventID eventID
ID firing event


velocity

protected Vector3Float velocity
ID firing event


locationInWorldCoordinates

protected Vector3Double locationInWorldCoordinates
where the detonation is, in world coordinates


burstDescriptor

protected BurstDescriptor burstDescriptor
Describes munition used


locationInEntityCoordinates

protected Vector3Float locationInEntityCoordinates
location of the detonation or impact in the target entity's coordinate system. This information should be used for damage assessment.


detonationResult

protected short detonationResult
result of the explosion


numberOfArticulationParameters

protected short numberOfArticulationParameters
How many articulation parameters we have


pad

protected short pad
padding


articulationParameters

protected java.util.List<ArticulationParameter> articulationParameters
Constructor Detail

DetonationPdu

public DetonationPdu()
Constructor

Method Detail

getMarshalledSize

public int getMarshalledSize()
Overrides:
getMarshalledSize in class WarfareFamilyPdu

setMunitionID

public void setMunitionID(EntityID pMunitionID)

getMunitionID

public EntityID getMunitionID()

setEventID

public void setEventID(EventID pEventID)

getEventID

public EventID getEventID()

setVelocity

public void setVelocity(Vector3Float pVelocity)

getVelocity

public Vector3Float getVelocity()

setLocationInWorldCoordinates

public void setLocationInWorldCoordinates(Vector3Double pLocationInWorldCoordinates)

getLocationInWorldCoordinates

public Vector3Double getLocationInWorldCoordinates()

setBurstDescriptor

public void setBurstDescriptor(BurstDescriptor pBurstDescriptor)

getBurstDescriptor

public BurstDescriptor getBurstDescriptor()

setLocationInEntityCoordinates

public void setLocationInEntityCoordinates(Vector3Float pLocationInEntityCoordinates)

getLocationInEntityCoordinates

public Vector3Float getLocationInEntityCoordinates()

setDetonationResult

public void setDetonationResult(short pDetonationResult)

getDetonationResult

public short getDetonationResult()

getNumberOfArticulationParameters

public short getNumberOfArticulationParameters()

setNumberOfArticulationParameters

public void setNumberOfArticulationParameters(short pNumberOfArticulationParameters)
Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose. The getnumberOfArticulationParameters method will also be based on the actual list length rather than this value. The method is simply here for java bean completeness.


setPad

public void setPad(short pPad)

getPad

public short getPad()

setArticulationParameters

public void setArticulationParameters(java.util.List<ArticulationParameter> pArticulationParameters)

getArticulationParameters

public java.util.List<ArticulationParameter> getArticulationParameters()

marshal

public void marshal(java.io.DataOutputStream dos)
Overrides:
marshal in class WarfareFamilyPdu

unmarshal

public void unmarshal(java.io.DataInputStream dis)
Overrides:
unmarshal in class WarfareFamilyPdu

marshal

public void marshal(java.nio.ByteBuffer buff)
Packs a Pdu into the ByteBuffer.

Overrides:
marshal in class WarfareFamilyPdu
Parameters:
buff - The ByteBuffer at the position to begin writing
Throws:
java.nio.BufferOverflowException - if buff is too small
java.nio.ReadOnlyBufferException - if buff is read only
Since:
??
See Also:
ByteBuffer

unmarshal

public void unmarshal(java.nio.ByteBuffer buff)
Unpacks a Pdu from the underlying data.

Overrides:
unmarshal in class WarfareFamilyPdu
Parameters:
buff - The ByteBuffer at the position to begin reading
Throws:
java.nio.BufferUnderflowException - if buff is too small
Since:
??
See Also:
ByteBuffer

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class WarfareFamilyPdu

equalsImpl

public boolean equalsImpl(java.lang.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.