Class DirectedEnergyTargetEnergyDeposition

java.lang.Object

edu.nps.moves.dis7.pdus.DirectedEnergyTargetEnergyDeposition

All Implemented Interfaces:

Serializable

public class DirectedEnergyTargetEnergyDeposition
extends Object
implements Serializable

DE energy depostion properties for a target entity. Section 6.2.20.4

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 short	padding	zero-filled array of padding bits for byte alignment and consistent sizing of PDU data
protected float	peakIrradiance	Peak irradiance
protected EntityID	targetEntityID	Unique ID of the target entity.

Constructor Summary

Constructors

Constructor	Description
DirectedEnergyTargetEnergyDeposition()	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
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
short	getPadding()	Getter for padding
float	getPeakIrradiance()	Getter for peakIrradiance
EntityID	getTargetEntityID()	Getter for targetEntityID
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
DirectedEnergyTargetEnergyDeposition	setPadding(int pPadding)	Utility setter for padding
DirectedEnergyTargetEnergyDeposition	setPadding(short pPadding)	Setter for padding
DirectedEnergyTargetEnergyDeposition	setPeakIrradiance(float pPeakIrradiance)	Setter for peakIrradiance
DirectedEnergyTargetEnergyDeposition	setTargetEntityID(EntityID pTargetEntityID)	Setter for targetEntityID
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

targetEntityID

protected EntityID targetEntityID

Unique ID of the target entity.

padding

protected short padding

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

peakIrradiance

protected float peakIrradiance

Peak irradiance

Constructor Details

DirectedEnergyTargetEnergyDeposition

public DirectedEnergyTargetEnergyDeposition()

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)

setTargetEntityID

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

setPadding

public DirectedEnergyTargetEnergyDeposition setPadding(short pPadding)

Setter for padding

Parameters:

pPadding - new value of interest

Returns:

same object to permit progressive setters

setPadding

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

setPeakIrradiance

public DirectedEnergyTargetEnergyDeposition setPeakIrradiance(float pPeakIrradiance)

Setter for peakIrradiance

Parameters:

pPeakIrradiance - new value of interest

Returns:

same object to permit progressive setters

getPeakIrradiance

public float getPeakIrradiance()

Getter for peakIrradiance

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