Class CommunicationsNodeID

java.lang.Object

edu.nps.moves.dis7.pdus.CommunicationsNodeID

All Implemented Interfaces:

Serializable

public class CommunicationsNodeID
extends Object
implements Serializable

Identity of a communications node. Section 6.2.48.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	elementID	elementID is an undescribed parameter...
protected EntityID	entityID	entityID is an undescribed parameter...

Constructor Summary

Constructors

Constructor	Description
CommunicationsNodeID()	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	getElementID()	Getter for elementID
EntityID	getEntityID()	Getter for entityID
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.
CommunicationsNodeID	setElementID(int pElementID)	Utility setter for elementID
CommunicationsNodeID	setElementID(short pElementID)	Setter for elementID
CommunicationsNodeID	setEntityID(EntityID pEntityID)	Setter for entityID
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

entityID

protected EntityID entityID

entityID is an undescribed parameter...

elementID

protected short elementID

elementID is an undescribed parameter...

Constructor Details

CommunicationsNodeID

public CommunicationsNodeID()

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)

setEntityID

public CommunicationsNodeID setEntityID(EntityID pEntityID)

Setter for entityID

Parameters:

pEntityID - new value of interest

Returns:

same object to permit progressive setters

getEntityID

public EntityID getEntityID()

Getter for entityID

Returns:

value of interest

setElementID

public CommunicationsNodeID setElementID(short pElementID)

Setter for elementID

Parameters:

pElementID - new value of interest

Returns:

same object to permit progressive setters

setElementID

public CommunicationsNodeID setElementID(int pElementID)

Utility setter for elementID

Parameters:

pElementID - new value of interest

Returns:

same object to permit progressive setters

getElementID

public short getElementID()

Getter for elementID

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