Class GroupID

java.lang.Object

edu.nps.moves.dis7.pdus.GroupID

All Implemented Interfaces:

Serializable

public class GroupID
extends Object
implements Serializable

Unique designation of a group of entities contained in the isGroupOfPdu. Represents a group of entities rather than a single entity. Section 6.2.43

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	groupNumber	group number
protected SimulationAddress	simulationAddress	Simulation address (site and application number)

Constructor Summary

Constructors

Constructor	Description
GroupID()	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	getGroupNumber()	Getter for groupNumber
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
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.
GroupID	setGroupNumber(int pGroupNumber)	Utility setter for groupNumber
GroupID	setGroupNumber(short pGroupNumber)	Setter for groupNumber
GroupID	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 (site and application number)

groupNumber

protected short groupNumber

group number

Constructor Details

GroupID

public GroupID()

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 GroupID 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

setGroupNumber

public GroupID setGroupNumber(short pGroupNumber)

Setter for groupNumber

Parameters:

pGroupNumber - new value of interest

Returns:

same object to permit progressive setters

setGroupNumber

public GroupID setGroupNumber(int pGroupNumber)

Utility setter for groupNumber

Parameters:

pGroupNumber - new value of interest

Returns:

same object to permit progressive setters

getGroupNumber

public short getGroupNumber()

Getter for groupNumber

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