Class AttachedPartVP

java.lang.Object

edu.nps.moves.dis7.pdus.AttachedPartVP

All Implemented Interfaces:

Serializable

public class AttachedPartVP
extends Object
implements Serializable

Removable parts that may be attached to an entity. Section 6.2.93.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 EntityType	attachedPartType	The definition of the 64-bits shall be determined based on the type of parameter specified in the Parameter Type field
protected AttachedPartDetachedIndicator	detachedIndicator	0 = attached, 1 = detached.
protected AttachedParts	parameterType	The location or station to which the part is attached uid 57
protected short	partAttachedTo	The identification of the articulated part to which this articulation parameter is attached.
protected VariableParameterRecordType	recordType	The identification of the Variable Parameter record.

Constructor Summary

Constructors

Constructor	Description
AttachedPartVP()	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
EntityType	getAttachedPartType()	Getter for attachedPartType
AttachedPartDetachedIndicator	getDetachedIndicator()	Getter for detachedIndicator
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
AttachedParts	getParameterType()	Getter for parameterType
short	getPartAttachedTo()	Getter for partAttachedTo
VariableParameterRecordType	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.
AttachedPartVP	setAttachedPartType(EntityType pAttachedPartType)	Setter for attachedPartType
AttachedPartVP	setDetachedIndicator(AttachedPartDetachedIndicator pDetachedIndicator)	Setter for detachedIndicator
AttachedPartVP	setParameterType(AttachedParts pParameterType)	Setter for parameterType
AttachedPartVP	setPartAttachedTo(int pPartAttachedTo)	Utility setter for partAttachedTo
AttachedPartVP	setPartAttachedTo(short pPartAttachedTo)	Setter for partAttachedTo
AttachedPartVP	setRecordType(VariableParameterRecordType 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 VariableParameterRecordType recordType

The identification of the Variable Parameter record. Enumeration from EBV uid 56

detachedIndicator

protected AttachedPartDetachedIndicator detachedIndicator

0 = attached, 1 = detached. See I.2.3.1 for state transition diagram uid 415

partAttachedTo

protected short partAttachedTo

The identification of the articulated part to which this articulation parameter is attached. This field shall be specified by a 16-bit unsigned integer. This field shall contain the value zero if the articulated part is attached directly to the entity.

parameterType

protected AttachedParts parameterType

The location or station to which the part is attached uid 57

attachedPartType

protected EntityType attachedPartType

The definition of the 64-bits shall be determined based on the type of parameter specified in the Parameter Type field

Constructor Details

AttachedPartVP

public AttachedPartVP()

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 AttachedPartVP setRecordType(VariableParameterRecordType pRecordType)

Setter for recordType

Parameters:

pRecordType - new value of interest

Returns:

same object to permit progressive setters

getRecordType

public VariableParameterRecordType getRecordType()

Getter for recordType

Returns:

value of interest

setDetachedIndicator

public AttachedPartVP setDetachedIndicator(AttachedPartDetachedIndicator pDetachedIndicator)

Setter for detachedIndicator

Parameters:

pDetachedIndicator - new value of interest

Returns:

same object to permit progressive setters

getDetachedIndicator

public AttachedPartDetachedIndicator getDetachedIndicator()

Getter for detachedIndicator

Returns:

value of interest

setPartAttachedTo

public AttachedPartVP setPartAttachedTo(short pPartAttachedTo)

Setter for partAttachedTo

Parameters:

pPartAttachedTo - new value of interest

Returns:

same object to permit progressive setters

setPartAttachedTo

public AttachedPartVP setPartAttachedTo(int pPartAttachedTo)

Utility setter for partAttachedTo

Parameters:

pPartAttachedTo - new value of interest

Returns:

same object to permit progressive setters

getPartAttachedTo

public short getPartAttachedTo()

Getter for partAttachedTo

Returns:

value of interest

setParameterType

public AttachedPartVP setParameterType(AttachedParts pParameterType)

Setter for parameterType

Parameters:

pParameterType - new value of interest

Returns:

same object to permit progressive setters

getParameterType

public AttachedParts getParameterType()

Getter for parameterType

Returns:

value of interest

setAttachedPartType

public AttachedPartVP setAttachedPartType(EntityType pAttachedPartType)

Setter for attachedPartType

Parameters:

pAttachedPartType - new value of interest

Returns:

same object to permit progressive setters

getAttachedPartType

public EntityType getAttachedPartType()

Getter for attachedPartType

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