include/vrfobjcore/orgManager.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2002 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: orgManager.h,v $ $Revision: 1.18 $ $State: Exp $
*******************************************************************************/
#ifndef orgManager_H_
#define orgManager_H_


#include <vlutil/vlConfig.h> 
#include <vector>
#include "vrfobjcore/orgView.h"
#include "vrfutil/callbackList.h"
#include "vrfmsgs/ifObjectIndexData.h"

#include "vrfobjcore/vrfobjcoreDefines.h"

class DtOrganizationChangeSet;
class DtSimInterfaceMessage;
class DtPrintPendingOpsCommand;
class DtDeletePendingOpsCommand;

typedef void (*DtOrganizationManagerCallbackFcn)(void* usr);

struct DtOrganizationManagerReadyCallbackInfo
{
   bool myReady;
};

typedef DtCallbackList<const DtOrganizationManagerReadyCallbackInfo&>::DtCallbackFunctionType
   DtOrganizationManagerReadyCallbackFcn;

class DT_DLL_vrfobjcore DtOrganizationManager : public DtOrganizationView
{
private:
   DtOrganizationManager();
   DtOrganizationManager(const DtOrganizationManager& orig);
   DtOrganizationManager& operator=(const DtOrganizationManager& orig);

public:
   typedef DtCallbackList<const DtOrganizationManagerReadyCallbackInfo&> DtOrganizationReadyCallbackList;

public:

   DtOrganizationManager(DtVrfObjectManager *objMgr);
   virtual ~DtOrganizationManager();

   virtual bool init();


   virtual DtOrganizationManagerNode* addEntity(DtVrfObject *vrfObject);

   virtual void removeEntity(DtVrfObject *vrfObject);

   virtual void updateAggregate(DtVrfObject *vrfObject);

   virtual void updateEntity(DtVrfObject *vrfObject);

   virtual void setSuperior(const DtEntityIdentifier& subordinateId,
      const DtEntityIdentifier& superiorId, int designator = 0,
      bool localOnly = false);
  
   virtual void setSuperiorToForce(const DtEntityIdentifier& subordinateId,
      int designator = 0, bool localOnly = false);

   virtual void queueSetSuperior(const DtString& subordinateName, 
      const DtString& superiorName, int designator = 0,
      DtOrganizationManagerCallbackFcn completionCallback = 0, void* usrData = 0);

   virtual void queueSetSuperiorToForce(const DtString& subordinateName, 
      int designator = 0, DtOrganizationManagerCallbackFcn completionCallback = 0, void* usrData = 0);

   virtual void queueChangeSet(const DtOrganizationChangeSet& changeSet, int& changeSetRequestId,
      DtOrganizationManagerCallbackFcn completionCallback = 0, void* usrData = 0);

   virtual void removeChangeSetCallback(int changeSetRequestId,
      DtOrganizationManagerCallbackFcn completionCallback, void* usrData = 0);

   virtual void detatchFromSuperior(const DtEntityIdentifier& subordinateId,
      bool localOnly = false);

   virtual void setSubordinateOrder(const DtEntityIdentifier& superiorId,
      const std::vector<DtEntityIdentifier>& orderedSubordinateList, 
      bool localOnly = false);

   static void addToOrganizationCallback(DtSimMessage* msg, void* usr);
   static void removeFromOrganizationCallback(DtSimMessage* msg, void* usr);

   static void objectAboutToBeRemovedCallback(DtVrfObject* vrfObject, 
      void* usr);
   virtual void processObjectAboutToBeRemoved();

   virtual bool allLocalOrgChangesComplete() const;

   virtual bool hasPendingOperations() const;

   virtual void addOrganizationManagerReadyCallback(
      DtOrganizationManagerReadyCallbackFcn fcn, void* usrData);

   virtual void removeOrganizationManagerReadyCallback(
      DtOrganizationManagerReadyCallbackFcn fcn, void* usrData);

   virtual void runPendingOperations();
   
   virtual void printPendingOperations() const;

   virtual void deletePendingOperations();

   virtual void deletePendingOperationsFor(DtString objectName);

   virtual void updateObjectIndex();

   virtual bool objectExistsInIndexByName(const DtString& name, 
      DtString& simAddress, DtString& objectId);

   virtual bool objectExistsInIndexByGlobalId(const DtString& globalId, DtString& simAddress);


   static void objectIndexMessageCallback(DtSimMessage* msg, void* usr);
   virtual void processObjectIndexMessage(DtSimInterfaceMessage* msg);

protected:
   virtual void invokeOrganizationManagerReadyCallbacks();

   virtual void processAddToOrganization(DtSimMessage* msg);
   virtual void processRemoveFromOrganization(DtSimMessage* msg);

   virtual bool setSuperiorIsLocal(const DtEntityIdentifier& subordinateId,
      const DtEntityIdentifier& superiorId);

   virtual bool setSuperiorToForceIsLocal(const DtEntityIdentifier& subordinateId);

   virtual bool detatchFromSuperiorIsLocal(const DtEntityIdentifier& subordinateId);

   virtual bool setSubordinateOrderIsLocal(const DtEntityIdentifier& superiorId) const;

   virtual void addOperationToQueue(DtOrgManagerOperation* operation);

   virtual unsigned int newPendingOperationId();

   virtual void clearPendingOperationId(unsigned int id);

   static void pendingOperationCompleteCallback(void* usr);

   static int nextId();

protected:
   typedef std::pair<DtOrganizationManager*, unsigned int> DtPendingOperationCompletionCallbackData;

   DtList myPendingOperationList;

   bool myOperationsRunning;

   std::list<unsigned int> myPendingOperationIdList;
   unsigned int myNextPendingOperationId;

   DtOrganizationReadyCallbackList myOrganizationManagerReadyCallbackList;

   std::map<DtString, DtNameToObjectIdMap> myReflectedObjectNames;

   std::map<DtString, DtStringSet> myReflectedObjectGlobalIds;

   double myLastObjectIndexSentTime;
   double myObjectIndexHeartbeatThreshold;
   bool myForceObjectIndexUpdate;

   DtPrintPendingOpsCommand* myPrintPendingOpsCommand;
   DtDeletePendingOpsCommand* myDeletePendingOpsCommand;

   static int theNextId;

};

#endif