defaultOwnershipHandler.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2014 VT MAK
** All rights reserved.
*********************************************************************/

#pragma once

#if DtHLA 

#include <vl/ownershipHandler.h>
#include <vl/objClassDesc.h>

#include <list>

enum DtOwnershipAction
{
   OWNERSHIP_CALLBACK,
   OWNERSHIP_ACCEPT_ALL,
   OWNERSHIP_DENY_ALL
};

typedef void (*DtAcquireOwnershipCb)(DtHlaObject* hlaObject, void* usr);
typedef void (*DtDivestOwnershipCb)(DtHlaObject* hlaObject, void* usr);

typedef bool (*DtAcquireOwnershipRequestCb)(DtHlaObject* hlaObject, void* usr); 
typedef bool (*DtDivestOwnershipRequestCb)(DtHlaObject* hlaObject, void* usr);

struct DtAcquireOwnershipCbInfo
{
  DtAcquireOwnershipCb cbFunction;
  void* userData;
};

struct DtDivestOwnershipCbInfo
{
  DtDivestOwnershipCb cbFunction;
  void* userData;
};

struct DtAcquireOwnershipRequestCbInfo
{
  DtAcquireOwnershipRequestCb cbFunction;
  void* userData;
};

struct DtDivestOwnershipRequestCbInfo
{
  DtDivestOwnershipRequestCb cbFunction;
  void* userData;
};
   
class DT_DLL_VL DtDefaultOwnershipHandler : public DtOwnershipHandler
{
public:
   DtDefaultOwnershipHandler();

   virtual ~DtDefaultOwnershipHandler();

   virtual DtOwnershipHandler* clone() const;

   DtDefaultOwnershipHandler(const DtDefaultOwnershipHandler& other);

   DtDefaultOwnershipHandler& operator=(const DtDefaultOwnershipHandler& other);
   
   virtual void setOwnershipAcquisitionAction(DtOwnershipAction);

   virtual void setOwnershipDivestitudeAction(DtOwnershipAction);

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

   virtual void loseOwnership(const RTI::AttributeHandleSet& set);

   //{@
   virtual void setAcquireOwnershipCallback(DtAcquireOwnershipCb cb, void* usr, 
      const DtObjClassDesc* desc = 0);
   
   //{@
   virtual void setDivestOwnershipCallback(DtDivestOwnershipCb cb, void* usr, 
      const DtObjClassDesc* desc = 0);
   
   //Callback for acquiring and divesting requests. Are only called if you have OWNERSHIP_CALLBACK defined
   //{@
   virtual void addAcquireOwnershipRequestCallback(DtAcquireOwnershipRequestCb cb, void* usr);
   virtual void removeAcquireOwnershipRequestCallback(DtAcquireOwnershipRequestCb cb, void* usr);
   
   virtual void addDivestOwnershipRequestCallback(DtDivestOwnershipRequestCb cb, void* usr);
   virtual void removeDivestOwnershipRequestCallback(DtDivestOwnershipRequestCb cb, void* usr);

   virtual bool requestAttributeOwnershipRelease (
      const RTI::AttributeHandleSet& candidateAttributes,
#if DtHLA_1516
      const RTI::VariableLengthData &theTag
#else
      const char* theTag
#endif
      );

   virtual void requestAttributeOwnershipAssumption (
      const RTI::AttributeHandleSet& offeredAttributes,
#if DtHLA_1516
      const RTI::VariableLengthData &theTag
#else
      const char* theTag
#endif
      );

protected:
   DtOwnershipAction myAcquisitionAction;
   DtOwnershipAction myDivestAction;
   
   std::map<RTI::ObjectClassHandle, DtAcquireOwnershipCbInfo> myAcquireOwnershipCbList;
   std::map<RTI::ObjectClassHandle, DtDivestOwnershipCbInfo> myDivestOwnershipCbList;
   DtAcquireOwnershipCbInfo myDefaultAcquireOwnershipCb;
   DtDivestOwnershipCbInfo myDefaultDivestOwnershipCb;
   std::list<DtAcquireOwnershipRequestCbInfo> myAcquireOwnershipRequestCbList;
   std::list<DtDivestOwnershipRequestCbInfo> myDivestOwnershipRequestCbList;
};


#endif //DtHLA