Class IOEffectRecord

java.lang.Object

edu.nps.moves.dis7.pdus.IORecord

edu.nps.moves.dis7.pdus.IOEffectRecord

All Implemented Interfaces:

Serializable

public class IOEffectRecord
extends IORecord
implements Serializable

6.2.48.3

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 IOEffectsRecordIOEffect	ioEffect	uid 292
protected short	ioEffectDuration	ioEffectDuration is an undescribed parameter...
protected byte	ioEffectDutyCycle	ioEffectDutyCycle is an undescribed parameter...
protected IOEffectsRecordIOLinkType	ioLinkType	uid 291
protected IOEffectsRecordIOProcess	ioProcess	uid 293
protected IOEffectsRecordIOStatus	ioStatus	uid 290
protected short	padding	zero-filled array of padding bits for byte alignment and consistent sizing of PDU data
protected short	recordLength	recordLength is an undescribed parameter...
protected VariableRecordType	recordType	uid 66 Variable Record Type values are defined by VariableRecordType enumerations

Constructor Summary

Constructors

Constructor	Description
IOEffectRecord()	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
IOEffectsRecordIOEffect	getIoEffect()	Getter for ioEffect
short	getIoEffectDuration()	Getter for ioEffectDuration
byte	getIoEffectDutyCycle()	Getter for ioEffectDutyCycle
IOEffectsRecordIOLinkType	getIoLinkType()	Getter for ioLinkType
IOEffectsRecordIOProcess	getIoProcess()	Getter for ioProcess
IOEffectsRecordIOStatus	getIoStatus()	Getter for ioStatus
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
short	getPadding()	Getter for padding
short	getRecordLength()	Getter for recordLength
VariableRecordType	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.
IOEffectRecord	setIoEffect(IOEffectsRecordIOEffect pIoEffect)	Setter for ioEffect
IOEffectRecord	setIoEffectDuration(int pIoEffectDuration)	Utility setter for ioEffectDuration
IOEffectRecord	setIoEffectDuration(short pIoEffectDuration)	Setter for ioEffectDuration
IOEffectRecord	setIoEffectDutyCycle(byte pIoEffectDutyCycle)	Setter for ioEffectDutyCycle
IOEffectRecord	setIoEffectDutyCycle(int pIoEffectDutyCycle)	Utility setter for ioEffectDutyCycle
IOEffectRecord	setIoLinkType(IOEffectsRecordIOLinkType pIoLinkType)	Setter for ioLinkType
IOEffectRecord	setIoProcess(IOEffectsRecordIOProcess pIoProcess)	Setter for ioProcess
IOEffectRecord	setIoStatus(IOEffectsRecordIOStatus pIoStatus)	Setter for ioStatus
IOEffectRecord	setPadding(int pPadding)	Utility setter for padding
IOEffectRecord	setPadding(short pPadding)	Setter for padding
IOEffectRecord	setRecordLength(int pRecordLength)	Utility setter for recordLength
IOEffectRecord	setRecordLength(short pRecordLength)	Setter for recordLength
IOEffectRecord	setRecordType(VariableRecordType 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 VariableRecordType recordType

uid 66 Variable Record Type values are defined by VariableRecordType enumerations

recordLength

protected short recordLength

recordLength is an undescribed parameter...

ioStatus

protected IOEffectsRecordIOStatus ioStatus

uid 290

ioLinkType

protected IOEffectsRecordIOLinkType ioLinkType

uid 291

ioEffect

protected IOEffectsRecordIOEffect ioEffect

uid 292

ioEffectDutyCycle

protected byte ioEffectDutyCycle

ioEffectDutyCycle is an undescribed parameter...

ioEffectDuration

protected short ioEffectDuration

ioEffectDuration is an undescribed parameter...

ioProcess

protected IOEffectsRecordIOProcess ioProcess

uid 293

padding

protected short padding

zero-filled array of padding bits for byte alignment and consistent sizing of PDU data

Constructor Details

IOEffectRecord

public IOEffectRecord()

Constructor creates and configures a new instance object

Method Details

getMarshalledSize

public int getMarshalledSize()

Returns size of this serialized (marshalled) object in bytes

Overrides:

getMarshalledSize in class IORecord

Returns:

serialized size in bytes

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

setRecordType

public IOEffectRecord setRecordType(VariableRecordType pRecordType)

Setter for recordType

Parameters:

pRecordType - new value of interest

Returns:

same object to permit progressive setters

getRecordType

public VariableRecordType getRecordType()

Getter for recordType

Returns:

value of interest

setRecordLength

public IOEffectRecord setRecordLength(short pRecordLength)

Setter for recordLength

Parameters:

pRecordLength - new value of interest

Returns:

same object to permit progressive setters

setRecordLength

public IOEffectRecord 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

setIoStatus

public IOEffectRecord setIoStatus(IOEffectsRecordIOStatus pIoStatus)

Setter for ioStatus

Parameters:

pIoStatus - new value of interest

Returns:

same object to permit progressive setters

getIoStatus

public IOEffectsRecordIOStatus getIoStatus()

Getter for ioStatus

Returns:

value of interest

setIoLinkType

public IOEffectRecord setIoLinkType(IOEffectsRecordIOLinkType pIoLinkType)

Setter for ioLinkType

Parameters:

pIoLinkType - new value of interest

Returns:

same object to permit progressive setters

getIoLinkType

public IOEffectsRecordIOLinkType getIoLinkType()

Getter for ioLinkType

Returns:

value of interest

setIoEffect

public IOEffectRecord setIoEffect(IOEffectsRecordIOEffect pIoEffect)

Setter for ioEffect

Parameters:

pIoEffect - new value of interest

Returns:

same object to permit progressive setters

getIoEffect

public IOEffectsRecordIOEffect getIoEffect()

Getter for ioEffect

Returns:

value of interest

setIoEffectDutyCycle

public IOEffectRecord setIoEffectDutyCycle(byte pIoEffectDutyCycle)

Setter for ioEffectDutyCycle

Parameters:

pIoEffectDutyCycle - new value of interest

Returns:

same object to permit progressive setters

setIoEffectDutyCycle

public IOEffectRecord setIoEffectDutyCycle(int pIoEffectDutyCycle)

Utility setter for ioEffectDutyCycle

Parameters:

pIoEffectDutyCycle - new value of interest

Returns:

same object to permit progressive setters

getIoEffectDutyCycle

public byte getIoEffectDutyCycle()

Getter for ioEffectDutyCycle

Returns:

value of interest

setIoEffectDuration

public IOEffectRecord setIoEffectDuration(short pIoEffectDuration)

Setter for ioEffectDuration

Parameters:

pIoEffectDuration - new value of interest

Returns:

same object to permit progressive setters

setIoEffectDuration

public IOEffectRecord setIoEffectDuration(int pIoEffectDuration)

Utility setter for ioEffectDuration

Parameters:

pIoEffectDuration - new value of interest

Returns:

same object to permit progressive setters

getIoEffectDuration

public short getIoEffectDuration()

Getter for ioEffectDuration

Returns:

value of interest

setIoProcess

public IOEffectRecord setIoProcess(IOEffectsRecordIOProcess pIoProcess)

Setter for ioProcess

Parameters:

pIoProcess - new value of interest

Returns:

same object to permit progressive setters

getIoProcess

public IOEffectsRecordIOProcess getIoProcess()

Getter for ioProcess

Returns:

value of interest

setPadding

public IOEffectRecord setPadding(short pPadding)

Setter for padding

Parameters:

pPadding - new value of interest

Returns:

same object to permit progressive setters

setPadding

public IOEffectRecord setPadding(int pPadding)

Utility setter for padding

Parameters:

pPadding - new value of interest

Returns:

same object to permit progressive setters

getPadding

public short getPadding()

Getter for padding

Returns:

value of interest

marshal

public void marshal(DataOutputStream dos)
             throws Exception

Serializes an object to a DataOutputStream.

Overrides:

marshal in class IORecord

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.

Overrides:

unmarshal in class IORecord

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.

Overrides:

marshal in class IORecord

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.

Overrides:

unmarshal in class IORecord

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 IORecord

equalsImpl

public boolean equalsImpl(Object obj)

Description copied from class: IORecord

Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object

Overrides:

equalsImpl in class IORecord

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class IORecord

hashCode

public int hashCode()

Overrides:

hashCode in class Object