Class RadioCommsHeader

java.lang.Object

edu.nps.moves.dis7.pdus.RadioCommsHeader

All Implemented Interfaces:

Serializable

public class RadioCommsHeader
extends Object
implements Serializable

Common PDU fields for Radio Communications family

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	radioNumber	particular radio within an entity
protected EntityID	radioReferenceID	ID of the entitythat is the source of the communication

Constructor Summary

Constructors

Constructor	Description
RadioCommsHeader()	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	getRadioNumber()	Getter for radioNumber
EntityID	getRadioReferenceID()	Getter for radioReferenceID
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
RadioCommsHeader	setRadioNumber(int pRadioNumber)	Utility setter for radioNumber
RadioCommsHeader	setRadioNumber(short pRadioNumber)	Setter for radioNumber
RadioCommsHeader	setRadioReferenceID(EntityID pRadioReferenceID)	Setter for radioReferenceID
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

radioReferenceID

protected EntityID radioReferenceID

ID of the entitythat is the source of the communication

radioNumber

protected short radioNumber

particular radio within an entity

Constructor Details

RadioCommsHeader

public RadioCommsHeader()

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)

setRadioReferenceID

public RadioCommsHeader setRadioReferenceID(EntityID pRadioReferenceID)

Setter for radioReferenceID

Parameters:

pRadioReferenceID - new value of interest

Returns:

same object to permit progressive setters

getRadioReferenceID

public EntityID getRadioReferenceID()

Getter for radioReferenceID

Returns:

value of interest

setRadioNumber

public RadioCommsHeader setRadioNumber(short pRadioNumber)

Setter for radioNumber

Parameters:

pRadioNumber - new value of interest

Returns:

same object to permit progressive setters

setRadioNumber

public RadioCommsHeader setRadioNumber(int pRadioNumber)

Utility setter for radioNumber

Parameters:

pRadioNumber - new value of interest

Returns:

same object to permit progressive setters

getRadioNumber

public short getRadioNumber()

Getter for radioNumber

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