DtOwnershipHandler Class Reference

This is a base class meant to encapsulate user callbacks on ownership management services. More...

Collaboration diagram for DtOwnershipHandler:

List of all members.

Public Member Functions
	DtOwnershipHandler ()
	Constructor.
virtual	~DtOwnershipHandler ()
	Destructor.
virtual DtHlaObject *	hlaObject ()
	Returns a pointer to the DtHlaObject with which this instance has been registered.
virtual void	gainOwnership (const RTI::AttributeHandleSet &set)
	Called whenever the local federate has gained ownership of a set of attributes.
virtual void	loseOwnership (const RTI::AttributeHandleSet &set)
	Called whenever the local federate has lost ownership of a set of attributes.
virtual void	attributeOwnershipDivestitureNotification (const RTI::AttributeHandleSet &releasedAttributes)
	Called as a result of the attributeOwnershipDivestitureNotification RTI service.
virtual void	attributeOwnershipAcquisitionNotification (const RTI::AttributeHandleSet &securedAttributes)
	Called as a result of the attributeOwnershipAcquisitionNotification RTI service.
virtual void	requestAttributeOwnershipAssumption (const RTI::AttributeHandleSet &offeredAttributes, const RTI::VariableLengthData &theTag)
	Called as a result of the requestAttributeOwnershipAssumption RTI service.
virtual void	requestAttributeOwnershipRelease (const RTI::AttributeHandleSet &candidateAttributes, const RTI::VariableLengthData &theTag)
	Called as a result of the requestAttributeOwnershipRelease RTI service.
virtual void	confirmAttributeOwnershipAcquisitionCancellation (const RTI::AttributeHandleSet &attributes)
	Called as a result of the confirmAttributeOwnershipAcquisitionCancellation RTI service.
Protected Member Functions
	DtOwnershipHandler (const DtOwnershipHandler &orig)
	Copy constructor - not implemented.
DtOwnershipHandler &	operator= (const DtOwnershipHandler &orig)
	Assignment operator - not implemented.
virtual void	setHlaObject (DtHlaObject *obj)
Protected Attributes
DtHlaObject *	myHlaObj
Friends
class	DtHlaObject

---

Detailed Description

This is a base class meant to encapsulate user callbacks on ownership management services.

Users should derive from this class, override the empty functions declared here with implementations that perform desired actions, and pass an instance of the subclass to DtHlaObject's setOwnershipHandler. When this is done, your implementations will be called at the appropriate times.

---

Constructor & Destructor Documentation

DtOwnershipHandler::DtOwnershipHandler

(

)

Constructor.

virtual DtOwnershipHandler::~DtOwnershipHandler

(

)

[virtual]

Destructor.

DtOwnershipHandler::DtOwnershipHandler

(

const DtOwnershipHandler &

orig

)

[protected]

Copy constructor - not implemented.

---

Member Function Documentation

virtual void DtOwnershipHandler::attributeOwnershipAcquisitionNotification

(

const RTI::AttributeHandleSet &

securedAttributes

)

[virtual]

Called as a result of the attributeOwnershipAcquisitionNotification RTI service.

virtual void DtOwnershipHandler::attributeOwnershipDivestitureNotification

(

const RTI::AttributeHandleSet &

releasedAttributes

)

[virtual]

Called as a result of the attributeOwnershipDivestitureNotification RTI service.

virtual void DtOwnershipHandler::confirmAttributeOwnershipAcquisitionCancellation

(

const RTI::AttributeHandleSet &

attributes

)

[virtual]

Called as a result of the confirmAttributeOwnershipAcquisitionCancellation RTI service.

virtual void DtOwnershipHandler::gainOwnership

(

const RTI::AttributeHandleSet &

set

)

[virtual]

Called whenever the local federate has gained ownership of a set of attributes.

This can happen as the result of an attributeOwnershipAcquisitionNotification RTI service call.

virtual DtHlaObject* DtOwnershipHandler::hlaObject

(

)

[virtual]

Returns a pointer to the DtHlaObject with which this instance has been registered.

virtual void DtOwnershipHandler::loseOwnership

(

const RTI::AttributeHandleSet &

set

)

[virtual]

Called whenever the local federate has lost ownership of a set of attributes.

This can happen as a result of an explicit or implicit unpublish, an attributeOwnershipDivestitureNotification RTI service call, or a call to DtHlaObject::unconditionalDivest.

DtOwnershipHandler& DtOwnershipHandler::operator=

(

const DtOwnershipHandler &

orig

)

[protected]

Assignment operator - not implemented.

virtual void DtOwnershipHandler::requestAttributeOwnershipAssumption	(	const RTI::AttributeHandleSet &	offeredAttributes,
		const RTI::VariableLengthData &	theTag
	)		[virtual]

Called as a result of the requestAttributeOwnershipAssumption RTI service.

You can call DtHlaObject's acquireAttributes even though you are within an RTI callback.

virtual void DtOwnershipHandler::requestAttributeOwnershipRelease	(	const RTI::AttributeHandleSet &	candidateAttributes,
		const RTI::VariableLengthData &	theTag
	)		[virtual]

Called as a result of the requestAttributeOwnershipRelease RTI service.

You can call DtHlaObject's negotiatedDivest or unconditionalDivest even though you are within an RTI callback.

virtual void DtOwnershipHandler::setHlaObject

(

DtHlaObject *

obj

)

[protected, virtual]

---

Friends And Related Function Documentation

friend class DtHlaObject [friend]

---

Member Data Documentation

DtHlaObject* DtOwnershipHandler::myHlaObj [protected]

---

The documentation for this class was generated from the following file:

• ownerHandler.h