orgManagerOperations.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2015 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
#pragma once


#include <vlutil/vlConfig.h> 
#include <vector>
#include <vl/hostStructs.h>
#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfobjcore/organizationManager.h"
#include "vrfutil/noArgumentCallbackList.h"
#include <vrfutil/rwUUID.h>

class DT_DLL_vrfobjcore DtOrgManagerOperation
{
private:
   DtOrgManagerOperation(const DtOrgManagerOperation& orig);
   DtOrgManagerOperation& operator=(DtOrgManagerOperation& orig);
      
public:
   DtOrgManagerOperation();
   virtual ~DtOrgManagerOperation();

   virtual DtString type() const = 0;

   virtual bool execute(DtOrganizationManager* orgMgr) = 0;

   virtual void print(DtOrganizationManager* orgMgr) const;
};

class DT_DLL_vrfobjcore DtOrgManagerPendingOperation : public DtOrgManagerOperation
{
private:
   DtOrgManagerPendingOperation(const DtOrgManagerPendingOperation& orig);
   DtOrgManagerPendingOperation& operator=(DtOrgManagerPendingOperation& orig);

public:
   DtOrgManagerPendingOperation();
   virtual ~DtOrgManagerPendingOperation();

   virtual void addCompletionCallback(DtOrganizationManagerCallbackFcn fcn, void* usr);
   virtual void removeCompletionCallback(DtOrganizationManagerCallbackFcn fcn, void* usr);

protected:
   virtual void invokeCompletionCallback();

protected:
   DtNoArgumentCallbackList myCompletionCallbackList;
};

class DT_DLL_vrfobjcore DtOrgManagerSuperiorAddSubordinateOp : public DtOrgManagerOperation
{
private:
   DtOrgManagerSuperiorAddSubordinateOp();

public:
   DtOrgManagerSuperiorAddSubordinateOp(const DtUUID& subordinate,
      const DtUUID& superior, int designator);

   virtual ~DtOrgManagerSuperiorAddSubordinateOp();

   virtual DtString type() const;

   virtual bool execute(DtOrganizationManager* orgMgr);

   virtual void print(DtOrganizationManager* orgMgr) const;

protected:
   DtRwUUID mySubordinateId;
   DtRwUUID mySuperiorId;
   int myDesignator;

};

class DT_DLL_vrfobjcore DtOrgManagerSuperiorRemoveSubordinateOp : public DtOrgManagerOperation
{
private:
   DtOrgManagerSuperiorRemoveSubordinateOp();

public:
   DtOrgManagerSuperiorRemoveSubordinateOp(const DtUUID& subordinate,
      const DtUUID& superior);

   virtual ~DtOrgManagerSuperiorRemoveSubordinateOp();

   virtual DtString type() const;

   virtual bool execute(DtOrganizationManager* orgMgr);

   virtual void print(DtOrganizationManager* orgMgr) const;

protected:
   DtRwUUID mySubordinateId;
   DtRwUUID mySuperiorId;
};

class DT_DLL_vrfobjcore DtOrgManagerSubordinateAttachToForceOp : public DtOrgManagerOperation
{
private:
   DtOrgManagerSubordinateAttachToForceOp();

public:
   DtOrgManagerSubordinateAttachToForceOp(const DtUUID& subordiante,
      int designator);

   virtual ~DtOrgManagerSubordinateAttachToForceOp();

   virtual DtString type() const;

   virtual bool execute(DtOrganizationManager* orgMgr);

   virtual void print(DtOrganizationManager* orgMgr) const;

protected:
   DtRwUUID mySubordinateId;
   int myDesignator;
};

class DT_DLL_vrfobjcore DtOrgManagerSubordinateDetatchToForceOp : public DtOrgManagerOperation
{
private:
   DtOrgManagerSubordinateDetatchToForceOp();

public:
   DtOrgManagerSubordinateDetatchToForceOp(const DtUUID& subordiante);

   virtual ~DtOrgManagerSubordinateDetatchToForceOp();

   virtual DtString type() const;

   virtual bool execute(DtOrganizationManager* orgMgr);

   virtual void print(DtOrganizationManager* orgMgr) const;

protected:
   DtRwUUID mySubordinateId;
};


class DT_DLL_vrfobjcore DtOrgManagerSetSuperiorPendingOp : public DtOrgManagerPendingOperation
{
private:
   DtOrgManagerSetSuperiorPendingOp();

public:
   DtOrgManagerSetSuperiorPendingOp(const DtUUID& subordinate,
      const DtUUID& superiorName, int designator);

   virtual ~DtOrgManagerSetSuperiorPendingOp();

   virtual DtString type() const;

   virtual bool execute(DtOrganizationManager* orgMgr);

   virtual void print(DtOrganizationManager* orgMgr) const;

protected:
   DtRwUUID mySubordinate;
   DtRwUUID mySuperior;
   int myDesignator;
   bool myWaitingCompletion;
};

class DT_DLL_vrfobjcore DtOrgManagerSetSuperiorToForcePendingOp : public DtOrgManagerPendingOperation
{
private:
   DtOrgManagerSetSuperiorToForcePendingOp();

public:
   DtOrgManagerSetSuperiorToForcePendingOp(const DtUUID& subordinate,
      int designator);

   virtual ~DtOrgManagerSetSuperiorToForcePendingOp();

   virtual DtString type() const;

   virtual bool execute(DtOrganizationManager* orgMgr);

   virtual void print(DtOrganizationManager* orgMgr) const;

   const DtUUID& subordinate() const;

   //Sets myEntityDeleted to true.
   static void entityRemovedCallback(DtVrfObject* object, void* user);
   virtual void processEntityRemoved(DtVrfObject* object);

protected:
   DtRwUUID mySubordinate;
   int myDesignator;
   bool myWaitingCompletion;

   //makes sure callback is only registered once.
   bool myCallbackAdded;
   //if the entity gets deleted before it is ever reflected,
   //this operation will never be able to complete. To fix this,
   //a callback was added for object about to be deleted.
   //That callback sets this to true, so the next time execute()
   //is called, it can return true because there's no longer
   //anything to do.
   bool myEntityDeleted;

   //Need to hold onto pointer to be able to unregister for callback.
   DtOrganizationManager* myOrgManager;
};

class DT_DLL_vrfobjcore DtOrgManagerSetSubordinateOrderOp : public DtOrgManagerOperation
{
private:
   DtOrgManagerSetSubordinateOrderOp();

public:
   DtOrgManagerSetSubordinateOrderOp(const DtUUID& superior,
   const std::vector<DtEntityIdentifier>& orderedSubordinateList);

   virtual ~DtOrgManagerSetSubordinateOrderOp();

   virtual DtString type() const;

   virtual bool execute(DtOrganizationManager* orgMgr);

   virtual void print(DtOrganizationManager* orgMgr) const;

protected:
   DtRwUUID mySuperiorId;
   std::vector<DtEntityIdentifier> myOrderedSubordinateList;
};