Class ExplosionDescriptor

java.lang.Object

edu.nps.moves.dis7.pdus.ExplosionDescriptor

All Implemented Interfaces:

Serializable

public class ExplosionDescriptor
extends Object
implements Serializable

Explosion of a non-munition. Section 6.2.19.3

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 EntityType	explodingObject	Type of the object that exploded.
protected float	explosiveForce	Force of explosion, in equivalent KG of TNT
protected ExplosiveMaterialCategories	explosiveMaterial	Material that exploded.
protected short	padding	zero-filled array of padding bits for byte alignment and consistent sizing of PDU data

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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
EntityType	getExplodingObject()	Getter for explodingObject
float	getExplosiveForce()	Getter for explosiveForce
ExplosiveMaterialCategories	getExplosiveMaterial()	Getter for explosiveMaterial
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
short	getPadding()	Getter for padding
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
ExplosionDescriptor	setExplodingObject(EntityType pExplodingObject)	Setter for explodingObject
ExplosionDescriptor	setExplosiveForce(float pExplosiveForce)	Setter for explosiveForce
ExplosionDescriptor	setExplosiveMaterial(ExplosiveMaterialCategories pExplosiveMaterial)	Setter for explosiveMaterial
ExplosionDescriptor	setPadding(int pPadding)	Utility setter for padding
ExplosionDescriptor	setPadding(short pPadding)	Setter for padding
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 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

explodingObject

protected EntityType explodingObject

Type of the object that exploded. See 6.2.30

explosiveMaterial

protected ExplosiveMaterialCategories explosiveMaterial

Material that exploded. Can be grain dust, tnt, gasoline, etc. Enumeration uid 310

padding

protected short padding

zero-filled array of padding bits for byte alignment and consistent sizing of PDU data

explosiveForce

protected float explosiveForce

Force of explosion, in equivalent KG of TNT

Constructor Details

ExplosionDescriptor

public ExplosionDescriptor()

Constructor creates and configures a new instance object

Method Details

getMarshalledSize

public int getMarshalledSize()

Returns size of this serialized (marshalled) object in bytes

Returns:

serialized size in bytes

See Also:

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

setExplodingObject

public ExplosionDescriptor setExplodingObject(EntityType pExplodingObject)

Setter for explodingObject

Parameters:

pExplodingObject - new value of interest

Returns:

same object to permit progressive setters

getExplodingObject

public EntityType getExplodingObject()

Getter for explodingObject

Returns:

value of interest

setExplosiveMaterial

public ExplosionDescriptor setExplosiveMaterial(ExplosiveMaterialCategories pExplosiveMaterial)

Setter for explosiveMaterial

Parameters:

pExplosiveMaterial - new value of interest

Returns:

same object to permit progressive setters

getExplosiveMaterial

public ExplosiveMaterialCategories getExplosiveMaterial()

Getter for explosiveMaterial

Returns:

value of interest

setPadding

public ExplosionDescriptor setPadding(short pPadding)

Setter for padding

Parameters:

pPadding - new value of interest

Returns:

same object to permit progressive setters

setPadding

public ExplosionDescriptor setPadding(int pPadding)

Utility setter for padding

Parameters:

pPadding - new value of interest

Returns:

same object to permit progressive setters

getPadding

public short getPadding()

Getter for padding

Returns:

value of interest

setExplosiveForce

public ExplosionDescriptor setExplosiveForce(float pExplosiveForce)

Setter for explosiveForce

Parameters:

pExplosiveForce - new value of interest

Returns:

same object to permit progressive setters

getExplosiveForce

public float getExplosiveForce()

Getter for explosiveForce

Returns:

value of interest

marshal

public void marshal(DataOutputStream dos)
             throws Exception

Serializes an object to a DataOutputStream.

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.

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.

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.

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 Object

equalsImpl

public boolean equalsImpl(Object obj)

Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object