Class EventIdentifierLiveEntity

java.lang.Object

edu.nps.moves.dis7.pdus.EventIdentifierLiveEntity

All Implemented Interfaces:

Serializable

public class EventIdentifierLiveEntity
extends Object
implements Serializable

Identifies an event in the world. Use this format for ONLY the LiveEntityPdu. Section 6.2.34.

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 byte	applicationNumber	applicationNumber is an undescribed parameter...
protected short	eventNumber	eventNumber is an undescribed parameter...
protected byte	siteNumber	siteNumber is an undescribed parameter...

Constructor Summary

Constructors

Constructor	Description
EventIdentifierLiveEntity()	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
byte	getApplicationNumber()	Getter for applicationNumber
short	getEventNumber()	Getter for eventNumber
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
byte	getSiteNumber()	Getter for siteNumber
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
EventIdentifierLiveEntity	setApplicationNumber(byte pApplicationNumber)	Setter for applicationNumber
EventIdentifierLiveEntity	setApplicationNumber(int pApplicationNumber)	Utility setter for applicationNumber
EventIdentifierLiveEntity	setEventNumber(int pEventNumber)	Utility setter for eventNumber
EventIdentifierLiveEntity	setEventNumber(short pEventNumber)	Setter for eventNumber
EventIdentifierLiveEntity	setSiteNumber(byte pSiteNumber)	Setter for siteNumber
EventIdentifierLiveEntity	setSiteNumber(int pSiteNumber)	Utility setter for siteNumber
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

siteNumber

protected byte siteNumber

siteNumber is an undescribed parameter...

applicationNumber

protected byte applicationNumber

applicationNumber is an undescribed parameter...

eventNumber

protected short eventNumber

eventNumber is an undescribed parameter...

Constructor Details

EventIdentifierLiveEntity

public EventIdentifierLiveEntity()

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)

setSiteNumber

public EventIdentifierLiveEntity setSiteNumber(byte pSiteNumber)

Setter for siteNumber

Parameters:

pSiteNumber - new value of interest

Returns:

same object to permit progressive setters

setSiteNumber

public EventIdentifierLiveEntity setSiteNumber(int pSiteNumber)

Utility setter for siteNumber

Parameters:

pSiteNumber - new value of interest

Returns:

same object to permit progressive setters

getSiteNumber

public byte getSiteNumber()

Getter for siteNumber

Returns:

value of interest

setApplicationNumber

public EventIdentifierLiveEntity setApplicationNumber(byte pApplicationNumber)

Setter for applicationNumber

Parameters:

pApplicationNumber - new value of interest

Returns:

same object to permit progressive setters

setApplicationNumber

public EventIdentifierLiveEntity setApplicationNumber(int pApplicationNumber)

Utility setter for applicationNumber

Parameters:

pApplicationNumber - new value of interest

Returns:

same object to permit progressive setters

getApplicationNumber

public byte getApplicationNumber()

Getter for applicationNumber

Returns:

value of interest

setEventNumber

public EventIdentifierLiveEntity setEventNumber(short pEventNumber)

Setter for eventNumber

Parameters:

pEventNumber - new value of interest

Returns:

same object to permit progressive setters

setEventNumber

public EventIdentifierLiveEntity setEventNumber(int pEventNumber)

Utility setter for eventNumber

Parameters:

pEventNumber - new value of interest

Returns:

same object to permit progressive setters

getEventNumber

public short getEventNumber()

Getter for eventNumber

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