Class MunitionDescriptor

java.lang.Object

edu.nps.moves.dis7.pdus.MunitionDescriptor

All Implemented Interfaces:

Serializable

public class MunitionDescriptor
extends Object
implements Serializable

Represents the firing or detonation of a munition. Section 6.2.19.2

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 MunitionDescriptorFuse	fuse	type of fuse used enumeration uid 61
protected EntityType	munitionType	What munition was used in the burst
protected short	quantity	how many of the munition were fired
protected short	rate	rate at which the munition was fired
protected MunitionDescriptorWarhead	warhead	type of warhead enumeration uid 60

Constructor Summary

Constructors

Constructor	Description
MunitionDescriptor()	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
MunitionDescriptorFuse	getFuse()	Getter for fuse
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
EntityType	getMunitionType()	Getter for munitionType
short	getQuantity()	Getter for quantity
short	getRate()	Getter for rate
MunitionDescriptorWarhead	getWarhead()	Getter for warhead
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
MunitionDescriptor	setFuse(MunitionDescriptorFuse pFuse)	Setter for fuse
MunitionDescriptor	setMunitionType(EntityType pMunitionType)	Setter for munitionType
MunitionDescriptor	setQuantity(int pQuantity)	Utility setter for quantity
MunitionDescriptor	setQuantity(short pQuantity)	Setter for quantity
MunitionDescriptor	setRate(int pRate)	Utility setter for rate
MunitionDescriptor	setRate(short pRate)	Setter for rate
MunitionDescriptor	setWarhead(MunitionDescriptorWarhead pWarhead)	Setter for warhead
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

munitionType

protected EntityType munitionType

What munition was used in the burst

warhead

protected MunitionDescriptorWarhead warhead

type of warhead enumeration uid 60

fuse

protected MunitionDescriptorFuse fuse

type of fuse used enumeration uid 61

quantity

protected short quantity

how many of the munition were fired

rate

protected short rate

rate at which the munition was fired

Constructor Details

MunitionDescriptor

public MunitionDescriptor()

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)

setMunitionType

public MunitionDescriptor setMunitionType(EntityType pMunitionType)

Setter for munitionType

Parameters:

pMunitionType - new value of interest

Returns:

same object to permit progressive setters

getMunitionType

public EntityType getMunitionType()

Getter for munitionType

Returns:

value of interest

setWarhead

public MunitionDescriptor setWarhead(MunitionDescriptorWarhead pWarhead)

Setter for warhead

Parameters:

pWarhead - new value of interest

Returns:

same object to permit progressive setters

getWarhead

public MunitionDescriptorWarhead getWarhead()

Getter for warhead

Returns:

value of interest

setFuse

public MunitionDescriptor setFuse(MunitionDescriptorFuse pFuse)

Setter for fuse

Parameters:

pFuse - new value of interest

Returns:

same object to permit progressive setters

getFuse

public MunitionDescriptorFuse getFuse()

Getter for fuse

Returns:

value of interest

setQuantity

public MunitionDescriptor setQuantity(short pQuantity)

Setter for quantity

Parameters:

pQuantity - new value of interest

Returns:

same object to permit progressive setters

setQuantity

public MunitionDescriptor setQuantity(int pQuantity)

Utility setter for quantity

Parameters:

pQuantity - new value of interest

Returns:

same object to permit progressive setters

getQuantity

public short getQuantity()

Getter for quantity

Returns:

value of interest

setRate

public MunitionDescriptor setRate(short pRate)

Setter for rate

Parameters:

pRate - new value of interest

Returns:

same object to permit progressive setters

setRate

public MunitionDescriptor setRate(int pRate)

Utility setter for rate

Parameters:

pRate - new value of interest

Returns:

same object to permit progressive setters

getRate

public short getRate()

Getter for rate

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