DtVrfScriptedTaskManager.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiConstants/vrfScriptedTasks.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/signalslib.h>
#include <vrfGuiCore/vrfGuiCore.h>
#include <vrfutil/scriptedTaskMetaData.h>
#include <vrvCore/DtDe.h>
#include <vlpi/simulationAddress.h>

class DtSimMessage;

namespace makVrf
{
   class DtVrfBackendState;

   class DT_DLL_VRFGUICORE DtVrfScriptedTaskManager : public makVrv::DtVirtualBaseClass
   {
   public:
      struct ScenarioSystemPair
      {
         ScenarioSystemPair() : scenarioScript(0), systemScript(0) {};
         ScenarioSystemPair(DtScriptedTaskMetaData* sc, DtScriptedTaskMetaData* sy) : scenarioScript(sc), systemScript(sy) {};

         DtScriptedTaskMetaData* scenarioScript;
         DtScriptedTaskMetaData* systemScript;
         std::string scriptError;                
         bool modified;
      };

      typedef std::map<std::string, ScenarioSystemPair> ScriptedTasks;
      typedef std::pair<std::string, bool> ActionCategory;
      typedef std::map<std::string, ActionCategory> ActionCategories;

      struct PreservedScript
      {
         DtScriptedTaskMetaData scriptedTask;
         std::string scriptError;
      };

      typedef std::map<std::string, PreservedScript> PreservedScripts;

   public:
      DtVrfScriptedTaskManager(makVrv::DtDe&);
      virtual ~DtVrfScriptedTaskManager();

      static DtVrfScriptedTaskManager& instance(makVrv::DtDe& de);
      static void registerInstance(makVrv::DtDe&, DtVrfScriptedTaskManager*);

      virtual void clear(bool andSetting = true);

      virtual void removeScriptedTaskMetaData(const std::string& scriptedTaskId, bool signal = true);

      virtual DtScriptedTaskMetaData scriptedTaskMetaData(const std::string& scriptId, bool system) const;

      virtual DtScriptedTaskMetaData scriptedTaskMetaData(const std::string& scriptId) const;

      virtual void addScriptedTaskMetaDataToScenario(const DtScriptedTaskMetaData&, bool addScript = false);

      virtual void duplicateScriptedTaskMetaDataToScenario(const DtScriptedTaskMetaData&, const std::string& sourceId);

      virtual void updateScriptedTaskMetaDataToScenario(const DtScriptedTaskMetaData&, const std::string& originalId = "");

      virtual void deleteScriptedTaskMetaData(const std::string&);

      virtual void addScriptedTaskMetaData(const DtScriptedTaskMetaData&, bool signal = true);

      virtual void requestScriptedTasks();

      virtual bool isSystemScript(const std::string&) const;

      virtual bool appearsOnMenu(const std::string&) const;

      virtual bool systemScriptAvailable(const std::string&) const;

      virtual void setSystemScriptAvailable(const std::string& id, bool);

      virtual void removeSystemScript(const std::string& id, bool signal = true);

      virtual const ScriptedTasks& scriptedTaskMetaData() const;
      
      virtual bool hasScriptedTaskMetaData(const std::string&) const;
      virtual bool hasScenarioScriptedTaskMetaData(const std::string&) const;
      virtual bool hasSystemScriptedTaskMetaData(const std::string&) const;

      virtual std::string uniqueScriptIdFrom(const std::string&,
         std::set<std::string> additionalToCheck = std::set<std::string>()) const;

      virtual void makeSystemScript(const std::string&);

      virtual void assignScriptError(const std::string& scriptId, const std::string& error);

      virtual void clearScriptError(const std::string& scriptId);

      virtual bool scriptHasError(const std::string& scriptId, std::string* error = 0) const;

      virtual bool scriptIsModified(const std::string& scriptId) const;

      virtual void setScriptModified(const std::string& scriptId, bool);

      virtual void clearModifiedScripts();

      virtual void setScript(const std::string& scriptId, const std::string& script, bool setAsModified = true);

      virtual bool hasModifiedScripts() const;

      virtual void preserveModifiedScripts();

      virtual void restorePreservedScripts();

      virtual int mapScriptIdToAction(const std::string& scriptId);

      virtual void unmapScriptId(const std::string&);

      virtual void setMonitorFrameRates(const std::string& scriptId, bool monitor);

      virtual const ActionCategories& actionCategories() const;

      virtual void requestScriptsIfNeeded();

   protected:
      virtual void receiveScriptedTaskList(DtSimMessage* msg);

      virtual void receiveActionCategories(DtSimMessage* msg);

      virtual void receivedScriptedTaskUpdateMessage(DtSimMessage* msg);

      virtual void slot_backendRemoved(const DtVrfBackendState&);

   public:
      boost::signal<void ()> signal_aboutToClearScriptedTasks;
      boost::signal<void (std::string)> signal_scriptedTaskAboutToBeRemoved;
      boost::signal<void (std::string)> signal_scriptedTaskAdded;
      boost::signal<void ()> signal_receivedScriptedTasks;

      boost::signal<void (std::string, bool, std::string)> signal_scriptErrorChange;

      boost::signal<void (std::string, bool)> signal_scriptModified;

      boost::signal<void ()> signal_scriptModifiedCleared;

      boost::signal<void (int, std::string)> signal_scriptRemovedFromTaskMenu;

      boost::signal<void (int, std::string)> signal_scriptAddedToTaskMenu;

   protected:
      makVrv::DtDe& myDe;
      ScriptedTasks myScriptedTasks;
      PreservedScripts myPreservedScripts;

      unsigned int myRequestId;

      typedef std::map<std::string, int> ScriptIdToActionIdMap;
      ScriptIdToActionIdMap myScriptIdToActionIdMap;

      DtSimulationAddress myScriptMonitorAddress;
      std::map<std::string, int> myMonitoring;

      ActionCategories myActionCategories;
      bool myRequestScriptsIfNeeded;
   };
}