Class IntercomCommunicationsParameters

java.lang.Object

edu.nps.moves.dis7.pdus.IntercomCommunicationsParameters

All Implemented Interfaces:

Serializable

public class IntercomCommunicationsParameters
extends Object
implements Serializable

Intercom communications parameters. Section 6.2.46

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	recordLength	length of record
protected byte[]	recordSpecificField	This is a placeholder.
protected IntercomControlRecordType	recordType	Type of intercom parameters record uid 185

Constructor Summary

Constructors

Constructor	Description
IntercomCommunicationsParameters()	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	getRecordLength()	Getter for recordLength
byte[]	getRecordSpecificField()	Getter for recordSpecificField
IntercomControlRecordType	getRecordType()	Getter for recordType
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
IntercomCommunicationsParameters	setRecordLength(int pRecordLength)	Utility setter for recordLength
IntercomCommunicationsParameters	setRecordLength(short pRecordLength)	Setter for recordLength
IntercomCommunicationsParameters	setRecordSpecificField(byte[] pRecordSpecificField)	Setter for recordSpecificField
IntercomCommunicationsParameters	setRecordType(IntercomControlRecordType pRecordType)	Setter for recordType
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

recordType

protected IntercomControlRecordType recordType

Type of intercom parameters record uid 185

recordLength

protected short recordLength

length of record

recordSpecificField

protected byte[] recordSpecificField

This is a placeholder.

Constructor Details

IntercomCommunicationsParameters

public IntercomCommunicationsParameters()

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)

setRecordType

public IntercomCommunicationsParameters setRecordType(IntercomControlRecordType pRecordType)

Setter for recordType

Parameters:

pRecordType - new value of interest

Returns:

same object to permit progressive setters

getRecordType

public IntercomControlRecordType getRecordType()

Getter for recordType

Returns:

value of interest

setRecordLength

public IntercomCommunicationsParameters setRecordLength(short pRecordLength)

Setter for recordLength

Parameters:

pRecordLength - new value of interest

Returns:

same object to permit progressive setters

setRecordLength

public IntercomCommunicationsParameters setRecordLength(int pRecordLength)

Utility setter for recordLength

Parameters:

pRecordLength - new value of interest

Returns:

same object to permit progressive setters

getRecordLength

public short getRecordLength()

Getter for recordLength

Returns:

value of interest

setRecordSpecificField

public IntercomCommunicationsParameters setRecordSpecificField(byte[] pRecordSpecificField)

Setter for recordSpecificField

Parameters:

pRecordSpecificField - new value of interest

Returns:

same object to permit progressive setters

getRecordSpecificField

public byte[] getRecordSpecificField()

Getter for recordSpecificField

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