syncMatrixController.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2021 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/


#pragma once

#include "vrfobjcore/controllerComponent.h"
#include "vrfmodel/vrfmodelDefines.h"
#include <tbb/mutex.h>

class DtSyncMatrixControllerPSR;
class DtRwSyncMatrixPhase;
class DtRwSyncMatrixPlan;
class DtRwSyncMatrixPlanList;
class DtPlan;

typedef std::map<DtUUID, boost::signals2::scoped_connection> SuperiorChangedCallbacksMap;

class DT_DLL_vrfmodel DtSyncMatrixController :  public DtControllerComponent
{
public:
   DtSyncMatrixController(const DtString& name, 
      DtLocalObject* owner,
      DtSimulationServices* simManager, 
      DtComponentDescriptor* desc = 0,
      DtReaderWriterRegistry* parentRegistry = 0);

   virtual ~DtSyncMatrixController() override;

   virtual bool init() override;

   virtual const char* type() const override;

   virtual void preFirstTickInit() override;

   virtual void tick() override;

   static DtSimComponent * creator(const DtString& name, 
      DtLocalObject* owner,
      DtSimulationServices* simManager, 
      DtComponentDescriptor* desc = 0,
      DtReaderWriterRegistry* parentRegistry = 0);

protected:

   virtual bool createPSR();

   static void syncMatrixRenameRequestCallback(const DtVrfObjectMessage * msg, void* usr);
   virtual void processSyncMatrixRenameRequest(const DtVrfObjectMessage * msg);

   static void syncMatrixRemovePhaseRequestCallback(const DtVrfObjectMessage * msg, void* usr);
   virtual void processSyncMatrixRemovePhaseRequest(const DtVrfObjectMessage * msg);

   static void syncMatrixInfoRequestCallback(const DtVrfObjectMessage * msg, void* usr);
   virtual void processSyncMatrixInfoRequest(const DtVrfObjectMessage * msg);

   static void syncMatrixAddObjectsRequestCallback(const DtVrfObjectMessage * msg, void* usr);
   virtual void processSyncMatrixAddObjectsRequest(const DtVrfObjectMessage * msg);

   static void syncMatrixRemoveObjectRequestCallback(const DtVrfObjectMessage * msg, void* usr);
   virtual void processSyncMatrixRemoveObjectRequest(const DtVrfObjectMessage * msg);

   static void syncMatrixPlanRequestCallback(const DtVrfObjectMessage * msg, void* usr);
   virtual void processSyncMatrixPlanRequest(const DtVrfObjectMessage * msg);

   static void syncMatrixSetPlanRequestCallback(const DtVrfObjectMessage * msg, void* usr);
   virtual void processSyncMatrixSetPlanRequest(const DtVrfObjectMessage * msg);

   static void syncMatrixRemovePlanRequestCallback(const DtVrfObjectMessage * msg, void* usr);
   virtual void processSyncMatrixRemovePlanRequest(const DtVrfObjectMessage * msg);

   static void syncMatrixPhaseInfoRequestCallback(const DtVrfObjectMessage * msg, void* usr);
   virtual void processSyncMatrixPhaseInfoRequest(const DtVrfObjectMessage * msg);

   static void syncMatrixActivatePlanRequestCallback(const DtVrfObjectMessage * msg, void* usr);
   virtual void processSyncMatrixActivatePlanRequest(const DtVrfObjectMessage * msg);

   static void planStatementMessageCallback(DtSimMessage* msg, void* usr);
   virtual void processPlanStatementMessage(DtSimMessage* msg);

   virtual void sendSyncMatrixRenameResponse();

   virtual void sendSyncMatrixRemoveResponse();

   virtual void sendSyncMatrixRemovePhaseResponse(const DtString& phaseName);

   virtual void sendSyncMatrixInfoResponse();

   virtual void sendSyncMatrixObjectsListResponse(bool refreshPlans);

   virtual void sendSyncMatrixPhaseInfoResponse(const DtString& origName, int phaseIndex, DtRwSyncMatrixPhase* phase, bool endConditionSpecified = true);

   virtual void sendSyncMatrixMoveToPhase(const DtString& requestedPhase, 
      const DtString& previousPhase = "", bool previousPhaseCompleted = false);

   virtual void sendSyncMatrixPlanStatus(const DtRwSyncMatrixPlanList& planStatusList);

   virtual bool isObjectSuperior(const DtSimObjectReference object1, const DtSimObjectReference object2, bool direct = false);
   virtual bool isObjectSuperior(const DtUUID& object1, const DtUUID& object2, bool direct = false);

   virtual void mergeRequestedObjects(const std::vector<DtUUID>& requestedObjects);

   virtual void executeObjectPlanInPhase(DtRwSyncMatrixPlan* planEntry);

   virtual void cancelObjectPlanInPhase(const DtRwSyncMatrixPlan* planEntry);

   virtual void removeObjectByUUID(const DtUUID& uuid, bool mergeSubordinates);

   virtual void processSimObjectDeleted(DtSimObjectReference object);
   virtual void processSuperiorChanged(const DtSimObject* object, const DtUUID& oldSuperior, const DtUUID& newSuperior);

   virtual void executePhasePlans();
   virtual void processPhasePlansStatus();

   virtual DtPlan* createAndInitPlan(const DtUUID& object);

   virtual void activatePlan(const DtUUID& uuid, const DtString& phaseName, bool activate);
   virtual void activatePlan(DtRwSyncMatrixPlan* planEntry, bool activate);

   virtual void abandonPlan(const DtUUID& uuid);
   virtual void registerToPlanStatus(const DtUUID& uuid);

   virtual void proceedToNextPhase();

   void initSuperiorChangedCallbacksMap();
   void resetSuperiorChangedCallbacksMap();
   void registerSuperiorChangedCallbacks();

   virtual void initPlanPhaseCallbacks();

private:

   DtSyncMatrixController();

   DtSyncMatrixController(const 
      DtSyncMatrixController & orig);

   const DtSyncMatrixController & operator=(
      const DtSyncMatrixController & orig);


protected:

   DtSyncMatrixControllerPSR* myProcessState;

   boost::signals2::scoped_connection mySimObjectDeletedConnection;

   SuperiorChangedCallbacksMap mySuperiorChangedCallbacksMap;
   bool mySuperiorChangedRegistrationIsComplete;
   tbb::mutex myRemovalMutex;
};