Class SimulationAddress

java.lang.Object

edu.nps.moves.dis7.pdus.SimulationAddress

All Implemented Interfaces:

Serializable

public class SimulationAddress
extends Object
implements Serializable

A Simulation Address record shall consist of the Site Identification number and the Application Identification number. Section 6.2.79

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	application	An application is defined as a software program that is used to generate and process distributed simulation data including live, virtual and constructive data.
protected short	site	A site is defined as a facility, installation, organizational unit or a geographic location that has one or more simulation applications capable of participating in a distributed event.

Constructor Summary

Constructors

Constructor	Description
SimulationAddress()	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	getApplication()	Getter for application
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
short	getSite()	Getter for site
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
SimulationAddress	setApplication(int pApplication)	Utility setter for application
SimulationAddress	setApplication(short pApplication)	Setter for application
SimulationAddress	setSite(int pSite)	Utility setter for site
SimulationAddress	setSite(short pSite)	Setter for site
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

site

protected short site

A site is defined as a facility, installation, organizational unit or a geographic location that has one or more simulation applications capable of participating in a distributed event.

application

protected short application

An application is defined as a software program that is used to generate and process distributed simulation data including live, virtual and constructive data.

Constructor Details

SimulationAddress

public SimulationAddress()

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)

setSite

public SimulationAddress setSite(short pSite)

Setter for site

Parameters:

pSite - new value of interest

Returns:

same object to permit progressive setters

setSite

public SimulationAddress setSite(int pSite)

Utility setter for site

Parameters:

pSite - new value of interest

Returns:

same object to permit progressive setters

getSite

public short getSite()

Getter for site

Returns:

value of interest

setApplication

public SimulationAddress setApplication(short pApplication)

Setter for application

Parameters:

pApplication - new value of interest

Returns:

same object to permit progressive setters

setApplication

public SimulationAddress setApplication(int pApplication)

Utility setter for application

Parameters:

pApplication - new value of interest

Returns:

same object to permit progressive setters

getApplication

public short getApplication()

Getter for application

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