basePlanWidgetLogic.h

Go to the documentation of this file.

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


#pragma once

#include <vrfGuiCoreQt/vrfGuiCoreQt.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrfGuiCore/vrfObjectManipulationHandlerBaseClass.h>

#include <vrvCore/DtSelectionManager.h>
#include <vrvCore/DtSelectionManager.h>
#include <vrvCore/DtSimObjectEntry.h>

#include <matrix/vlVector.h>

#include <vrfplan/plan.h>
#include <QtCore/QString>

namespace makVrv
{
   class DtDe;
   class DtSimEntry;
}

class DtRwTriggersList;
class DtSimBlock;
class DtStmtIndex;
class DtSetDataRequest;
class DtSimTask;
class DtSimCommand;
class DtSimMessage;
class DtEntityType;

namespace makVrf
{
   class DtPlanWidgetInterface;
   class DtPlanStatementItem;

   class DT_DLL_VRFGUICOREQT DtBasePlanWidgetLogic
   {

   public: 
      
      DtBasePlanWidgetLogic(makVrv::DtDe& de, DtPlanWidgetInterface* iFace );
         
      virtual ~DtBasePlanWidgetLogic();

      virtual void requestPlan(const std::vector<DtUUID>&) = 0;

      virtual bool sendPlan(bool reregister = true) = 0;

      virtual void planSelectionChanged() = 0;

      virtual void restartPlan() = 0;

      virtual void abandonPlan() = 0;

      virtual void replacePlan() = 0;

      virtual void setupGui(const makVrv::DtSelectionManager::IdSet&) = 0;

      virtual bool planIsModified() const = 0;

      virtual bool deleteStatement(DtPlanStatementItem*) = 0;

      virtual void deleteAllStatements() = 0;

      virtual void addSetRequest(const DtSetDataRequest&) = 0;

      virtual void addTaskRequest(const DtSimTask&) = 0;

      virtual void addCommandRequest(DtSimCommand&) = 0;

      virtual void addConditional(const DtSimStatement& stmt) = 0;
      virtual void addTrigger(const DtSimStatement& stmt, bool andSelect) = 0;

      virtual void editCurrentPlanStatement(const std::vector<makVrv::DtSimEntry*>&) = 0;

      virtual void finalizeObjectCreation(const DtVrfObjectManipulationHandlerBaseClass::ObjectManipulationData&) = 0;

      virtual bool editing() const = 0;

      virtual bool globalPlan() const;

      virtual void enableReplacePlan();
      virtual bool canPastePlan() const;

      virtual void cleanupUnusedTriggers(bool showNeverShowAgain = false) = 0;
      virtual void removeTrigger(const DtUUID&) = 0;
      virtual void editTrigger(const std::vector<makVrv::DtSimEntry*>& states, const DtUUID&) = 0;

      virtual void cleanup() = 0;

      virtual bool planUnlockedByUser() const
      {
         return myPlanUnlockedByUser;
      }

      virtual bool planLocked() const;
      virtual void userLockPlan(bool);

   public:
      virtual void printPlan();

      virtual void copySelectedPlanStatement();
      virtual void copyPlan();

      virtual void setPlanName(const DtUUID&);
      virtual const DtUUID& planName() const;

      virtual void setMarkingTextTitle(const QString&);
      
      virtual void cancel(bool force = false);

      virtual void accept();

      virtual void connectSignals(const std::vector<makVrv::DtSimEntry*>& s);

      virtual void setTitle();

      virtual DtPlan* plan();

      virtual void setClosingBecauseObjectRemoved(bool b) { myClosingBecauseObjectRemoved = b; };
      virtual bool closingBecauseObjectRemoved() const { return myClosingBecauseObjectRemoved; };

   protected:
      virtual void receivedPlanCallback(DtSimMessage*);

      virtual void processReceivePlan(const DtUUID&, 
         bool isGlobal, const std::vector<DtSimStatement*>& statements,
         const DtRwTriggersList&, const DtRwVariableBindings& variables) = 0;

      virtual void receivedPlanStatementCallback(DtSimMessage*);

      virtual void processPlanStatement(const DtUUID&, bool isGlobal, DtPlanStatus status,
         bool reselect = true) = 0;
      virtual void processReceiveCurrentStatement(const DtUUID&, bool isGlobal, DtPlanStatus status,
         bool reselect = true) = 0;
      virtual void processReceivePlanComplete(const DtUUID&, bool isGlobal) = 0;

      virtual void addStatementsToPlan(const std::vector<DtSimStatement*>& statements, bool append);

      virtual void displayPlan();
      virtual void clearAllStatements();

      virtual void displayPlanStatusString(DtPlanStatus status);

   protected:
      virtual void slot_objectAboutToBeRemoved(makVrv::DtSimObjectEntry&);
      virtual void updatePlanLockState();

   protected:
      makVrv::DtDe&            myDe;
      DtPlanWidgetInterface*  myInterface;
      DtUUID                 myName;
      std::vector<makVrv::DtSimEntry*> myConnectedTo;
      makVrv::DtSignalConnectionManager myConnectionManager;
      makVrv::DtSignalConnectionManager myPlanLockConnections;
      bool myClosingBecauseObjectRemoved;
      bool myIgnoreNextPlanStatementReceipt;
      bool myPlanUnlockedByUser = false;
   };
}