Class TransferOwnershipPdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.PduBase

edu.nps.moves.dis7.pdus.EntityManagementFamilyPdu

edu.nps.moves.dis7.pdus.TransferOwnershipPdu

All Implemented Interfaces:

Marshaller, Serializable

public class TransferOwnershipPdu
extends EntityManagementFamilyPdu
implements Serializable

Information initiating the dyanic allocation and control of simulation entities between two simulation applications.

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 ByteArrayOutputStream	byteArrayOutputStream	byteArrayOutputStream (baos) is used for marshal/unmarshal serialization
protected DataOutputStream	dataOutputStream	dataOutputStream (dos) is used for marshal/unmarshal serialization
static final String	NAME	The name of this PDU type
protected EntityID	originatingEntityID	ID of entity originating request
protected EntityID	receivingEntityID	ID of entity receiving request
protected RecordSpecification	recordSets	recordSets is an undescribed parameter...
protected int	requestID	ID of request
protected RequiredReliabilityService	requiredReliabilityService	required level of reliability service. uid 74
protected EntityID	transferEntityID	The entity for which control is being requested to transfer
protected TransferControlTransferType	transferType	type of transfer desired uid 224

Fields inherited from class edu.nps.moves.dis7.pdus.EntityManagementFamilyPdu

FAMILY_NAME

Fields inherited from class edu.nps.moves.dis7.pdus.PduBase

padding, pduStatus

Fields inherited from class edu.nps.moves.dis7.pdus.Pdu

exerciseID, length, pduType, protocolFamily, protocolVersion, timestamp

Constructor Summary

Constructors

Constructor	Description
TransferOwnershipPdu()	Constructor creates and configures a new instance object

Method Summary

Modifier and Type	Method	Description
TransferOwnershipPdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
TransferOwnershipPdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
TransferOwnershipPdu	copyDataOutputStream()	copy method creates a deep copy of current object using DataOutputStream methods.
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
EntityID	getOriginatingEntityID()	Getter for originatingEntityID
EntityID	getReceivingEntityID()	Getter for receivingEntityID
RecordSpecification	getRecordSets()	Getter for recordSets
int	getRequestID()	Getter for requestID
RequiredReliabilityService	getRequiredReliabilityService()	Getter for requiredReliabilityService
EntityID	getTransferEntityID()	Getter for transferEntityID
TransferControlTransferType	getTransferType()	Getter for transferType
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
TransferOwnershipPdu	setOriginatingEntityID(EntityID pOriginatingEntityID)	Setter for originatingEntityID
TransferOwnershipPdu	setReceivingEntityID(EntityID pReceivingEntityID)	Setter for receivingEntityID
TransferOwnershipPdu	setRecordSets(RecordSpecification pRecordSets)	Setter for recordSets
TransferOwnershipPdu	setRequestID(int pRequestID)	Setter for requestID
TransferOwnershipPdu	setRequiredReliabilityService(RequiredReliabilityService pRequiredReliabilityService)	Setter for requiredReliabilityService
TransferOwnershipPdu	setTransferEntityID(EntityID pTransferEntityID)	Setter for transferEntityID
TransferOwnershipPdu	setTransferType(TransferControlTransferType pTransferType)	Setter for transferType
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 edu.nps.moves.dis7.pdus.PduBase

getPadding, getPduStatus, setPadding, setPadding, setPduStatus

Methods inherited from class edu.nps.moves.dis7.pdus.Pdu

copyByPduFactory, getExerciseID, getLength, getPduType, getProtocolFamily, getProtocolVersion, getTimestamp, getTimestampSeconds, isAcknowledgeRPdu, isActionRequestPdu, isActionRequestRPdu, isActionResponsePdu, isActionResponseRPdu, isAggregateStatePdu, isAppearancePdu, isArealObjectStatePdu, isArticulatedPartsPdu, isAttributePdu, isCollisionElasticPdu, isCollisionPdu, isCommentPdu, isCommentRPdu, isCreateEntityPdu, isCreateEntityRPdu, isDataPdu, isDataQueryPdu, isDataQueryRPdu, isDataRPdu, isDesignatorPdu, isDetonationPdu, isDirectedEnergyFirePdu, isDistributedEmissionsRegenerationFamilyPdu, isElectromagneticEmissionPdu, isEntityDamageStatusPdu, isEntityInformationInteractionFamilyPdu, isEntityManagementFamilyPdu, isEntityStatePdu, isEntityStateUpdatePdu, isEnvironmentalProcessPdu, isEventReportPdu, isEventReportRPdu, isFirePdu, isGriddedDataPdu, isIFFPdu, isInformationOperationsActionPdu, isInformationOperationsFamilyPdu, isInformationOperationsReportPdu, isIntercomControlPdu, isIntercomSignalPdu, isIsGroupOfPdu, isIsPartOfPdu, isLEDetonationPdu, isLEFirePdu, isLinearObjectStatePdu, isLiveEntityDetonationPdu, isLiveEntityFirePdu, isLogisticsFamilyPdu, isMinefieldDataPdu, isMinefieldFamilyPdu, isMinefieldQueryPdu, isMinefieldResponseNACKPdu, isMinefieldStatePdu, isPointObjectStatePdu, isRadioCommunicationsFamilyPdu, isReceiverPdu, isRecordQueryRPdu, isRecordRPdu, isReliablePdu, isRemoveEntityPdu, isRemoveEntityRPdu, isRepairCompletePdu, isRepairResponsePdu, isResupplyCancelPdu, isResupplyOfferPdu, isResupplyReceivedPdu, isSEESPdu, isSetDataPdu, isSetDataRPdu, isSetRecordRPdu, isSignalPdu, isSimulationManagementFamilyPdu, isSimulationManagementWithReliabilityFamilyPdu, isStartResumePdu, isStartResumeRPdu, isStopFreezePdu, isStopFreezeRPdu, isSupplementalEmissionEntityStatePdu, isSyntheticEnvironmentFamilyPdu, isTransferOwnershipPdu, isTransmitterPdu, isTSPIPdu, isUnderwaterAcousticPdu, isWarfareFamilyPdu, marshal, occursAfter, occursBefore, occursSameTime, setExerciseID, setExerciseID, setLength, setLength, setPduType, setProtocolFamily, setProtocolVersion, setTimestamp, setTimestampSeconds

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

NAME

public static final String NAME

The name of this PDU type

See Also:

• Constant Field Values

originatingEntityID

protected EntityID originatingEntityID

ID of entity originating request

receivingEntityID

protected EntityID receivingEntityID

ID of entity receiving request

requestID

protected int requestID

ID of request

requiredReliabilityService

protected RequiredReliabilityService requiredReliabilityService

required level of reliability service. uid 74

transferType

protected TransferControlTransferType transferType

type of transfer desired uid 224

transferEntityID

protected EntityID transferEntityID

The entity for which control is being requested to transfer

recordSets

protected RecordSpecification recordSets

recordSets is an undescribed parameter...

byteArrayOutputStream

protected ByteArrayOutputStream byteArrayOutputStream

byteArrayOutputStream (baos) is used for marshal/unmarshal serialization

See Also:

• copyDataOutputStream()

dataOutputStream

protected DataOutputStream dataOutputStream

dataOutputStream (dos) is used for marshal/unmarshal serialization

See Also:

• copyDataOutputStream()

Constructor Details

TransferOwnershipPdu

public TransferOwnershipPdu()

Constructor creates and configures a new instance object

Method Details

copy

public TransferOwnershipPdu copy()

copy method creates a deep copy of current object using preferred marshalling method

Returns:

deep copy of PDU

copyByteBuffer

public TransferOwnershipPdu copyByteBuffer()

Creates a "deep copy" of current object using ByteBuffer methods.

Returns:

deep copy of PDU

copyDataOutputStream

public TransferOwnershipPdu copyDataOutputStream()

copy method creates a deep copy of current object using DataOutputStream methods.

Returns:

deep copy of PDU

getMarshalledSize

public int getMarshalledSize()

Returns size of this serialized (marshalled) object in bytes

Specified by:

getMarshalledSize in interface Marshaller

Overrides:

getMarshalledSize in class EntityManagementFamilyPdu

Returns:

serialized size in bytes

See Also:

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

setOriginatingEntityID

public TransferOwnershipPdu setOriginatingEntityID(EntityID pOriginatingEntityID)

Setter for originatingEntityID

Parameters:

pOriginatingEntityID - new value of interest

Returns:

same object to permit progressive setters

getOriginatingEntityID

public EntityID getOriginatingEntityID()

Getter for originatingEntityID

Returns:

value of interest

setReceivingEntityID

public TransferOwnershipPdu setReceivingEntityID(EntityID pReceivingEntityID)

Setter for receivingEntityID

Parameters:

pReceivingEntityID - new value of interest

Returns:

same object to permit progressive setters

getReceivingEntityID

public EntityID getReceivingEntityID()

Getter for receivingEntityID

Returns:

value of interest

setRequestID

public TransferOwnershipPdu setRequestID(int pRequestID)

Setter for requestID

Parameters:

pRequestID - new value of interest

Returns:

same object to permit progressive setters

getRequestID

public int getRequestID()

Getter for requestID

Returns:

value of interest

setRequiredReliabilityService

public TransferOwnershipPdu setRequiredReliabilityService(RequiredReliabilityService pRequiredReliabilityService)

Setter for requiredReliabilityService

Parameters:

pRequiredReliabilityService - new value of interest

Returns:

same object to permit progressive setters

getRequiredReliabilityService

public RequiredReliabilityService getRequiredReliabilityService()

Getter for requiredReliabilityService

Returns:

value of interest

setTransferType

public TransferOwnershipPdu setTransferType(TransferControlTransferType pTransferType)

Setter for transferType

Parameters:

pTransferType - new value of interest

Returns:

same object to permit progressive setters

getTransferType

public TransferControlTransferType getTransferType()

Getter for transferType

Returns:

value of interest

setTransferEntityID

public TransferOwnershipPdu setTransferEntityID(EntityID pTransferEntityID)

Setter for transferEntityID

Parameters:

pTransferEntityID - new value of interest

Returns:

same object to permit progressive setters

getTransferEntityID

public EntityID getTransferEntityID()

Getter for transferEntityID

Returns:

value of interest

setRecordSets

public TransferOwnershipPdu setRecordSets(RecordSpecification pRecordSets)

Setter for recordSets

Parameters:

pRecordSets - new value of interest

Returns:

same object to permit progressive setters

getRecordSets

public RecordSpecification getRecordSets()

Getter for recordSets

Returns:

value of interest

marshal

public void marshal(DataOutputStream dos)
             throws Exception

Serializes an object to a DataOutputStream.

Specified by:

marshal in interface Marshaller

Overrides:

marshal in class EntityManagementFamilyPdu

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.

Specified by:

unmarshal in interface Marshaller

Overrides:

unmarshal in class EntityManagementFamilyPdu

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.

Specified by:

marshal in interface Marshaller

Overrides:

marshal in class EntityManagementFamilyPdu

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.

Specified by:

unmarshal in interface Marshaller

Overrides:

unmarshal in class EntityManagementFamilyPdu

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 EntityManagementFamilyPdu

equalsImpl

public boolean equalsImpl(Object obj)

Description copied from class: Pdu

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

Overrides:

equalsImpl in class EntityManagementFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class EntityManagementFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class PduBase