Class Relationship

java.lang.Object

edu.nps.moves.dis7.pdus.Relationship

All Implemented Interfaces:

Serializable

public class Relationship
extends Object
implements Serializable

The relationship of the part entity to its host entity. Section 6.2.74.

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 IsPartOfNature	nature	The nature or purpose for joining of the part entity to the host entity and shall be represented by a 16-bit enumeration uid 210
protected IsPartOfPosition	position	The position of the part entity with respect to the host entity and shall be represented by a 16-bit enumeration uid 211

Constructor Summary

Constructors

Constructor	Description
Relationship()	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
IsPartOfNature	getNature()	Getter for nature
IsPartOfPosition	getPosition()	Getter for position
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
Relationship	setNature(IsPartOfNature pNature)	Setter for nature
Relationship	setPosition(IsPartOfPosition pPosition)	Setter for position
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

nature

protected IsPartOfNature nature

The nature or purpose for joining of the part entity to the host entity and shall be represented by a 16-bit enumeration uid 210

position

protected IsPartOfPosition position

The position of the part entity with respect to the host entity and shall be represented by a 16-bit enumeration uid 211

Constructor Details

Relationship

public Relationship()

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)

setNature

public Relationship setNature(IsPartOfNature pNature)

Setter for nature

Parameters:

pNature - new value of interest

Returns:

same object to permit progressive setters

getNature

public IsPartOfNature getNature()

Getter for nature

Returns:

value of interest

setPosition

public Relationship setPosition(IsPartOfPosition pPosition)

Setter for position

Parameters:

pPosition - new value of interest

Returns:

same object to permit progressive setters

getPosition

public IsPartOfPosition getPosition()

Getter for position

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