Class SimulationIdentifier

java.lang.Object

edu.nps.moves.dis7.pdus.SimulationIdentifier

All Implemented Interfaces:

Serializable

public class SimulationIdentifier
extends Object
implements Serializable

The unique designation of a simulation when using the 48-bit identifier format shall be specified by the Sim- ulation Identifier record. The reason that the 48-bit format is required in addition to the 32-bit simulation address format that actually identifies a specific simulation is because some 48-bit identifier fields in PDUs may contain either an Object Identifier, such as an Entity ID, or a Simulation Identifier. Section 6.2.80

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	referenceNumber	This field shall be set to zero as there is no reference number associated with a Simulation Identifier.
protected SimulationAddress	simulationAddress	Simulation address

Constructor Summary

Constructors

Constructor	Description
SimulationIdentifier()	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	getReferenceNumber()	Getter for referenceNumber
SimulationAddress	getSimulationAddress()	Getter for simulationAddress
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
SimulationIdentifier	setReferenceNumber(int pReferenceNumber)	Utility setter for referenceNumber
SimulationIdentifier	setReferenceNumber(short pReferenceNumber)	Setter for referenceNumber
SimulationIdentifier	setSimulationAddress(SimulationAddress pSimulationAddress)	Setter for simulationAddress
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

simulationAddress

protected SimulationAddress simulationAddress

Simulation address

referenceNumber

protected short referenceNumber

This field shall be set to zero as there is no reference number associated with a Simulation Identifier.

Constructor Details

SimulationIdentifier

public SimulationIdentifier()

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)

setSimulationAddress

public SimulationIdentifier setSimulationAddress(SimulationAddress pSimulationAddress)

Setter for simulationAddress

Parameters:

pSimulationAddress - new value of interest

Returns:

same object to permit progressive setters

getSimulationAddress

public SimulationAddress getSimulationAddress()

Getter for simulationAddress

Returns:

value of interest

setReferenceNumber

public SimulationIdentifier setReferenceNumber(short pReferenceNumber)

Setter for referenceNumber

Parameters:

pReferenceNumber - new value of interest

Returns:

same object to permit progressive setters

setReferenceNumber

public SimulationIdentifier setReferenceNumber(int pReferenceNumber)

Utility setter for referenceNumber

Parameters:

pReferenceNumber - new value of interest

Returns:

same object to permit progressive setters

getReferenceNumber

public short getReferenceNumber()

Getter for referenceNumber

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