Class LiveSimulationAddress

java.lang.Object

edu.nps.moves.dis7.pdus.LiveSimulationAddress

All Implemented Interfaces:

Serializable

public class LiveSimulationAddress
extends Object
implements Serializable

A simulation's designation associated with all Live Entity IDs contained in Live Entity PDUs. Section 6.2.55

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	liveApplicationNumber	An application associated with a live site is termed a live application.
protected byte	liveSiteNumber	facility, installation, organizational unit or geographic location may have multiple sites associated with it.

Constructor Summary

Constructors

Constructor	Description
LiveSimulationAddress()	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	getLiveApplicationNumber()	Getter for liveApplicationNumber
byte	getLiveSiteNumber()	Getter for liveSiteNumber
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.
LiveSimulationAddress	setLiveApplicationNumber(byte pLiveApplicationNumber)	Setter for liveApplicationNumber
LiveSimulationAddress	setLiveApplicationNumber(int pLiveApplicationNumber)	Utility setter for liveApplicationNumber
LiveSimulationAddress	setLiveSiteNumber(byte pLiveSiteNumber)	Setter for liveSiteNumber
LiveSimulationAddress	setLiveSiteNumber(int pLiveSiteNumber)	Utility setter for liveSiteNumber
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

liveSiteNumber

protected byte liveSiteNumber

facility, installation, organizational unit or geographic location may have multiple sites associated with it. The Site Number is the first component of the Live Simulation Address, which defines a live simulation.

liveApplicationNumber

protected byte liveApplicationNumber

An application associated with a live site is termed a live application. Each live application participating in an event

Constructor Details

LiveSimulationAddress

public LiveSimulationAddress()

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)

setLiveSiteNumber

public LiveSimulationAddress setLiveSiteNumber(byte pLiveSiteNumber)

Setter for liveSiteNumber

Parameters:

pLiveSiteNumber - new value of interest

Returns:

same object to permit progressive setters

setLiveSiteNumber

public LiveSimulationAddress setLiveSiteNumber(int pLiveSiteNumber)

Utility setter for liveSiteNumber

Parameters:

pLiveSiteNumber - new value of interest

Returns:

same object to permit progressive setters

getLiveSiteNumber

public byte getLiveSiteNumber()

Getter for liveSiteNumber

Returns:

value of interest

setLiveApplicationNumber

public LiveSimulationAddress setLiveApplicationNumber(byte pLiveApplicationNumber)

Setter for liveApplicationNumber

Parameters:

pLiveApplicationNumber - new value of interest

Returns:

same object to permit progressive setters

setLiveApplicationNumber

public LiveSimulationAddress setLiveApplicationNumber(int pLiveApplicationNumber)

Utility setter for liveApplicationNumber

Parameters:

pLiveApplicationNumber - new value of interest

Returns:

same object to permit progressive setters

getLiveApplicationNumber

public byte getLiveApplicationNumber()

Getter for liveApplicationNumber

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