Class DatumSpecification

java.lang.Object

edu.nps.moves.dis7.pdus.DatumSpecification

All Implemented Interfaces:

Serializable

public class DatumSpecification
extends Object
implements Serializable

List of fixed and variable datum records. Section 6.2.18

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 List<FixedDatum>	fixedDatumIDList	variable length list fixed datums
protected int	numberOfFixedDatums	Number of fixed datums
protected int	numberOfVariableDatums	Number of variable datums
protected List<VariableDatum>	variableDatumIDList	variable length list of variable datums

Constructor Summary

Constructors

Constructor	Description
DatumSpecification()	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
List<FixedDatum>	getFixedDatumIDList()	Getter for fixedDatumIDList
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
List<VariableDatum>	getVariableDatumIDList()	Getter for variableDatumIDList
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
DatumSpecification	setFixedDatumIDList(List<FixedDatum> pFixedDatumIDList)	Setter for fixedDatumIDList
DatumSpecification	setVariableDatumIDList(List<VariableDatum> pVariableDatumIDList)	Setter for variableDatumIDList
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

numberOfFixedDatums

protected int numberOfFixedDatums

Number of fixed datums

numberOfVariableDatums

protected int numberOfVariableDatums

Number of variable datums

fixedDatumIDList

protected List<FixedDatum> fixedDatumIDList

variable length list fixed datums

variableDatumIDList

protected List<VariableDatum> variableDatumIDList

variable length list of variable datums

Constructor Details

DatumSpecification

public DatumSpecification()

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)

setFixedDatumIDList

public DatumSpecification setFixedDatumIDList(List<FixedDatum> pFixedDatumIDList)

Setter for fixedDatumIDList

Parameters:

pFixedDatumIDList - new value of interest

Returns:

same object to permit progressive setters

getFixedDatumIDList

public List<FixedDatum> getFixedDatumIDList()

Getter for fixedDatumIDList

Returns:

value of interest

setVariableDatumIDList

public DatumSpecification setVariableDatumIDList(List<VariableDatum> pVariableDatumIDList)

Setter for variableDatumIDList

Parameters:

pVariableDatumIDList - new value of interest

Returns:

same object to permit progressive setters

getVariableDatumIDList

public List<VariableDatum> getVariableDatumIDList()

Getter for variableDatumIDList

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