Class LiveEntityIdentifier

java.lang.Object

edu.nps.moves.dis7.pdus.LiveEntityIdentifier

All Implemented Interfaces:

Serializable

public class LiveEntityIdentifier
extends Object
implements Serializable

The unique designation of each entity in an event or exercise that is contained in a Live Entity PDU. Section 6.2.54

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	entityNumber	Live entity number
protected LiveSimulationAddress	liveSimulationAddress	Live Simulation Address record (see 6.2.54)

Constructor Summary

Constructors

Constructor	Description
LiveEntityIdentifier()	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
short	getEntityNumber()	Getter for entityNumber
LiveSimulationAddress	getLiveSimulationAddress()	Getter for liveSimulationAddress
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
LiveEntityIdentifier	setEntityNumber(int pEntityNumber)	Utility setter for entityNumber
LiveEntityIdentifier	setEntityNumber(short pEntityNumber)	Setter for entityNumber
LiveEntityIdentifier	setLiveSimulationAddress(LiveSimulationAddress pLiveSimulationAddress)	Setter for liveSimulationAddress
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

liveSimulationAddress

protected LiveSimulationAddress liveSimulationAddress

Live Simulation Address record (see 6.2.54)

entityNumber

protected short entityNumber

Live entity number

Constructor Details

LiveEntityIdentifier

public LiveEntityIdentifier()

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)

setLiveSimulationAddress

public LiveEntityIdentifier setLiveSimulationAddress(LiveSimulationAddress pLiveSimulationAddress)

Setter for liveSimulationAddress

Parameters:

pLiveSimulationAddress - new value of interest

Returns:

same object to permit progressive setters

getLiveSimulationAddress

public LiveSimulationAddress getLiveSimulationAddress()

Getter for liveSimulationAddress

Returns:

value of interest

setEntityNumber

public LiveEntityIdentifier setEntityNumber(short pEntityNumber)

Setter for entityNumber

Parameters:

pEntityNumber - new value of interest

Returns:

same object to permit progressive setters

setEntityNumber

public LiveEntityIdentifier setEntityNumber(int pEntityNumber)

Utility setter for entityNumber

Parameters:

pEntityNumber - new value of interest

Returns:

same object to permit progressive setters

getEntityNumber

public short getEntityNumber()

Getter for entityNumber

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