Class OwnershipStatusRecord

java.lang.Object

edu.nps.moves.dis7.pdus.OwnershipStatusRecord

All Implemented Interfaces:

Serializable

public class OwnershipStatusRecord
extends Object
implements Serializable

used to convey entity and conflict status information associated with transferring ownership of an entity. Section 6.2.65

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 EntityID	entityId	EntityID
protected OwnershipStatus	ownershipStatus	The ownership and/or ownership conflict status of the entity represented by the Entity ID field. uid 332
protected byte	padding	zero-filled array of padding bits for byte alignment and consistent sizing of PDU data

Constructor Summary

Constructors

Constructor	Description
OwnershipStatusRecord()	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
EntityID	getEntityId()	Getter for entityId
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
OwnershipStatus	getOwnershipStatus()	Getter for ownershipStatus
byte	getPadding()	Getter for padding
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
OwnershipStatusRecord	setEntityId(EntityID pEntityId)	Setter for entityId
OwnershipStatusRecord	setOwnershipStatus(OwnershipStatus pOwnershipStatus)	Setter for ownershipStatus
OwnershipStatusRecord	setPadding(byte pPadding)	Setter for padding
OwnershipStatusRecord	setPadding(int pPadding)	Utility setter for padding
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

entityId

protected EntityID entityId

EntityID

ownershipStatus

protected OwnershipStatus ownershipStatus

The ownership and/or ownership conflict status of the entity represented by the Entity ID field. uid 332

padding

protected byte padding

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

Constructor Details

OwnershipStatusRecord

public OwnershipStatusRecord()

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)

setEntityId

public OwnershipStatusRecord setEntityId(EntityID pEntityId)

Setter for entityId

Parameters:

pEntityId - new value of interest

Returns:

same object to permit progressive setters

getEntityId

public EntityID getEntityId()

Getter for entityId

Returns:

value of interest

setOwnershipStatus

public OwnershipStatusRecord setOwnershipStatus(OwnershipStatus pOwnershipStatus)

Setter for ownershipStatus

Parameters:

pOwnershipStatus - new value of interest

Returns:

same object to permit progressive setters

getOwnershipStatus

public OwnershipStatus getOwnershipStatus()

Getter for ownershipStatus

Returns:

value of interest

setPadding

public OwnershipStatusRecord setPadding(byte pPadding)

Setter for padding

Parameters:

pPadding - new value of interest

Returns:

same object to permit progressive setters

setPadding

public OwnershipStatusRecord setPadding(int pPadding)

Utility setter for padding

Parameters:

pPadding - new value of interest

Returns:

same object to permit progressive setters

getPadding

public byte getPadding()

Getter for padding

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