VR-Link API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
DtPartialOwnershipHandler Class Reference

This class extends the default ownership handler and adds new callbacks to be activated whenever partial ownership has been transferred Only when full ownership is transferred will the default ownership handlers be called. More...

+ Inheritance diagram for DtPartialOwnershipHandler:
+ Collaboration diagram for DtPartialOwnershipHandler:

Public Member Functions

 DtPartialOwnershipHandler ()
 Constructor. More...
 
virtual ~DtPartialOwnershipHandler ()
 Destructor. More...
 
virtual DtOwnershipHandlerclone () const
 Clone copy. More...
 
 DtPartialOwnershipHandler (const DtPartialOwnershipHandler &other)
 Copy constructor. More...
 
DtPartialOwnershipHandleroperator= (const DtPartialOwnershipHandler &other)
 Assignment operator. More...
 
virtual void gainOwnership (const RTI::AttributeHandleSet &set)
 Called whenever the local federate has acquired ownership of a set of attributes. More...
 
virtual void loseOwnership (const RTI::AttributeHandleSet &set)
 Called whenever the local federate has lost ownership of a set of attributes. More...
 
virtual void addPartialAcquireOwnershipCallback (DtPartialAcquireOwnershipCb cb, void *usr, const DtObjClassDesc *desc=0)
 Callback for Acquiring ownership when only part of the object is acquired. More...
 
virtual void removePartialAcquireOwnershipCallback (DtPartialAcquireOwnershipCb cb, void *usr, const DtObjClassDesc *desc=0)
 
virtual void addPartialDivestOwnershipCallback (DtPartialDivestOwnershipCb cb, void *usr, const DtObjClassDesc *desc=0)
 Callback for divesting ownership when only part of the object is divested. More...
 
virtual void removePartialDivestOwnershipCallback (DtPartialDivestOwnershipCb cb, void *usr, const DtObjClassDesc *desc=0)
 
virtual void addPartialAcquireOwnershipRequestCallback (DtPartialAcquireOwnershipRequestCb cb, void *usr)
 Callbacks for Acquiring ownership. More...
 
virtual void removePartialAcquireOwnershipRequestCallback (DtPartialAcquireOwnershipRequestCb cb, void *usr)
 
virtual void addPartialDivestOwnershipRequestCallback (DtPartialDivestOwnershipRequestCb cb, void *usr)
 Callbacks for divesting ownership. More...
 
virtual void removePartialDivestOwnershipRequestCallback (DtPartialDivestOwnershipRequestCb cb, void *usr)
 
- Public Member Functions inherited from DtDefaultOwnershipHandler
 DtDefaultOwnershipHandler ()
 Constructor. More...
 
virtual ~DtDefaultOwnershipHandler ()
 Destructor. More...
 
 DtDefaultOwnershipHandler (const DtDefaultOwnershipHandler &other)
 Copy constructor. More...
 
DtDefaultOwnershipHandleroperator= (const DtDefaultOwnershipHandler &other)
 Assignment operator. More...
 
virtual void setOwnershipAcquisitionAction (DtOwnershipAction)
 Set the default action when someone offers an object to acquire Your three options are, accept, deny, or send a callback to ask for this information. More...
 
virtual void setOwnershipDivestitudeAction (DtOwnershipAction)
 Set the default action when someone requests your object to acquire Your three options are, accept, deny, or send a callback to ask for this information. More...
 
virtual void addAcquireOwnershipCallback (DtAcquireOwnershipCb cb, void *usr, const DtObjClassDesc *desc=0)
 Callback for Acquiring ownership. More...
 
virtual void removeAcquireOwnershipCallback (DtAcquireOwnershipCb cb, void *usr, const DtObjClassDesc *desc=0)
 
virtual void addDivestOwnershipCallback (DtDivestOwnershipCb cb, void *usr, const DtObjClassDesc *desc=0)
 Callback for divesting ownership. More...
 
virtual void removeDivestOwnershipCallback (DtDivestOwnershipCb cb, void *usr, const DtObjClassDesc *desc=0)
 
virtual void addAcquireOwnershipRequestCallback (DtAcquireOwnershipRequestCb cb, void *usr)
 Callback for acquiring and divesting requests. More...
 
virtual void removeAcquireOwnershipRequestCallback (DtAcquireOwnershipRequestCb cb, void *usr)
 
virtual void addDivestOwnershipRequestCallback (DtDivestOwnershipRequestCb cb, void *usr)
 
virtual void removeDivestOwnershipRequestCallback (DtDivestOwnershipRequestCb cb, void *usr)
 
virtual bool requesteOwnershipRelease (const RTI::AttributeHandleSet &candidateAttributes, const char *theTag)
 Called as a result of the requestAttributeOwnershipRelease RTI service. More...
 
virtual void requestAttributeOwnershipAssumption (const RTI::AttributeHandleSet &offeredAttributes, const char *theTag)
 Called as a result of the requestAttributeOwnershipAssumption RTI service. More...
 
- Public Member Functions inherited from DtOwnershipHandler
 DtOwnershipHandler ()
 Constructor. More...
 
virtual ~DtOwnershipHandler ()
 Destructor. More...
 
 DtOwnershipHandler (const DtOwnershipHandler &other)
 Copy constructor. More...
 
DtOwnershipHandleroperator= (const DtOwnershipHandler &other)
 Assignment operator. More...
 
virtual DtHlaObjecthlaObject ()
 Returns a pointer to the DtHlaObject with which this instance has been registered. More...
 
virtual void attributeOwnershipDivestitureNotification (const RTI::AttributeHandleSet &releasedAttributes)
 Called as a result of the attributeOwnershipDivestitureNotification RTI service. More...
 
virtual void attributeOwnershipAcquisitionNotification (const RTI::AttributeHandleSet &securedAttributes)
 Called as a result of the attributeOwnershipAcquisitionNotification RTI service. More...
 
virtual void confirmAttributeOwnershipAcquisitionCancellation (const RTI::AttributeHandleSet &attributes)
 Called as a result of the confirmAttributeOwnershipAcquisitionCancellation RTI service. More...
 

Protected Attributes

std::map
< RTI::ObjectClassHandle,
std::list
< DtPartialAcquireOwnershipCbInfo > > 
myPartialAcquireOwnershipCbList
 
std::map
< RTI::ObjectClassHandle,
std::list
< DtPartialDivestOwnershipCbInfo > > 
myPartialDivestOwnershipCbList
 
std::list
< DtPartialAcquireOwnershipCbInfo
myDefaultPartialAcquireOwnershipCb
 
std::list
< DtPartialDivestOwnershipCbInfo
myDefaultPartialDivestOwnershipCb
 
std::list
< DtPartialAcquireOwnershipRequestCbInfo
myPartialAcquireOwnershipRequestCbList
 
std::list
< DtPartialDivestOwnershipRequestCbInfo
myPartialDivestOwnershipRequestCbList
 
- Protected Attributes inherited from DtDefaultOwnershipHandler
DtOwnershipAction myAcquisitionAction
 
DtOwnershipAction myDivestAction
 
std::map
< RTI::ObjectClassHandle,
std::list
< DtAcquireOwnershipCbInfo > > 
myAcquireOwnershipCbList
 
std::map
< RTI::ObjectClassHandle,
std::list
< DtDivestOwnershipCbInfo > > 
myDivestOwnershipCbList
 
std::list
< DtAcquireOwnershipCbInfo
myDefaultAcquireOwnershipCb
 
std::list
< DtDivestOwnershipCbInfo
myDefaultDivestOwnershipCb
 
std::list
< DtAcquireOwnershipRequestCbInfo
myAcquireOwnershipRequestCbList
 
std::list
< DtDivestOwnershipRequestCbInfo
myDivestOwnershipRequestCbList
 
- Protected Attributes inherited from DtOwnershipHandler
DtHlaObjectmyHlaObj
 

Additional Inherited Members

- Protected Member Functions inherited from DtOwnershipHandler
virtual void setHlaObject (DtHlaObject *obj)
 

Detailed Description

This class extends the default ownership handler and adds new callbacks to be activated whenever partial ownership has been transferred Only when full ownership is transferred will the default ownership handlers be called.

Constructor & Destructor Documentation

DtPartialOwnershipHandler::DtPartialOwnershipHandler ( )

Constructor.

virtual DtPartialOwnershipHandler::~DtPartialOwnershipHandler ( )
virtual

Destructor.

DtPartialOwnershipHandler::DtPartialOwnershipHandler ( const DtPartialOwnershipHandler other)

Copy constructor.

Member Function Documentation

virtual void DtPartialOwnershipHandler::addPartialAcquireOwnershipCallback ( DtPartialAcquireOwnershipCb  cb,
void *  usr,
const DtObjClassDesc desc = 0 
)
virtual

Callback for Acquiring ownership when only part of the object is acquired.

This callback includes a list of attributes acquired but is otherwise the same as the default ownership handler callback.

virtual void DtPartialOwnershipHandler::addPartialAcquireOwnershipRequestCallback ( DtPartialAcquireOwnershipRequestCb  cb,
void *  usr 
)
virtual

Callbacks for Acquiring ownership.

Allows you to decide if you should accept or reject this ownership request. While there may be many callbacks, this will accept if just a single one returns true. This callback includes a list of attributes acquired but is otherwise the same as the default ownership handler callback.

virtual void DtPartialOwnershipHandler::addPartialDivestOwnershipCallback ( DtPartialDivestOwnershipCb  cb,
void *  usr,
const DtObjClassDesc desc = 0 
)
virtual

Callback for divesting ownership when only part of the object is divested.

This callback includes a list of attributes divested but is otherwise the same as the default ownership handler callback.

virtual void DtPartialOwnershipHandler::addPartialDivestOwnershipRequestCallback ( DtPartialDivestOwnershipRequestCb  cb,
void *  usr 
)
virtual

Callbacks for divesting ownership.

Allows you to decide if you should accept or reject this ownership request. While there may be many callbacks, this will accept if just a single one returns true. This callback includes a list of attributes divested but is otherwise the same as the default ownership handler callback.

virtual DtOwnershipHandler* DtPartialOwnershipHandler::clone ( ) const
virtual

Clone copy.

Reimplemented from DtDefaultOwnershipHandler.

virtual void DtPartialOwnershipHandler::gainOwnership ( const RTI::AttributeHandleSet &  set)
virtual

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

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

Reimplemented from DtDefaultOwnershipHandler.

virtual void DtPartialOwnershipHandler::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.

Reimplemented from DtDefaultOwnershipHandler.

DtPartialOwnershipHandler& DtPartialOwnershipHandler::operator= ( const DtPartialOwnershipHandler other)

Assignment operator.

virtual void DtPartialOwnershipHandler::removePartialAcquireOwnershipCallback ( DtPartialAcquireOwnershipCb  cb,
void *  usr,
const DtObjClassDesc desc = 0 
)
virtual
virtual void DtPartialOwnershipHandler::removePartialAcquireOwnershipRequestCallback ( DtPartialAcquireOwnershipRequestCb  cb,
void *  usr 
)
virtual
virtual void DtPartialOwnershipHandler::removePartialDivestOwnershipCallback ( DtPartialDivestOwnershipCb  cb,
void *  usr,
const DtObjClassDesc desc = 0 
)
virtual
virtual void DtPartialOwnershipHandler::removePartialDivestOwnershipRequestCallback ( DtPartialDivestOwnershipRequestCb  cb,
void *  usr 
)
virtual

Member Data Documentation

std::list<DtPartialAcquireOwnershipCbInfo> DtPartialOwnershipHandler::myDefaultPartialAcquireOwnershipCb
protected
std::list<DtPartialDivestOwnershipCbInfo> DtPartialOwnershipHandler::myDefaultPartialDivestOwnershipCb
protected
std::map<RTI::ObjectClassHandle, std::list<DtPartialAcquireOwnershipCbInfo> > DtPartialOwnershipHandler::myPartialAcquireOwnershipCbList
protected
std::list<DtPartialAcquireOwnershipRequestCbInfo> DtPartialOwnershipHandler::myPartialAcquireOwnershipRequestCbList
protected
std::map<RTI::ObjectClassHandle, std::list<DtPartialDivestOwnershipCbInfo> > DtPartialOwnershipHandler::myPartialDivestOwnershipCbList
protected
std::list<DtPartialDivestOwnershipRequestCbInfo> DtPartialOwnershipHandler::myPartialDivestOwnershipRequestCbList
protected

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

Document ID: Generated on Thu Sep 19 02:12:35 EDT 2024 from SVN revision 269601
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)