spotReportDataProcessor.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiCore/guiSimObject.h>
#include <vrfGuiCore/vrfGuiCore.h>
#include <vrfutil/rwUUID.h>

#include <vrvCore/DtUniqueID.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrvUtil/DtVirtualBaseClass.h>

#include <set>

class DtSpotReport;

namespace makVrv
{
   class DtDe;
}

namespace makVrf
{
   class DtGuiLocalObject;
   class DtSpotReportDataHandler;
   class DtSpotReportDataHandlerCreatorInterface;
   class DtVrfSimBackendManager;

   class DT_DLL_VRFGUICORE DtSpotReportDataProcessor : public makVrv::DtVirtualBaseClass
   {
   public:

      static DtSpotReportDataProcessor& instance(makVrv::DtDe& de);

      void forceObjectUpdate(makVrv::DtUniqueID uniqueId);

   public:
      virtual void addSpotReportHandler(const std::string& s, DtSpotReportDataHandlerCreatorInterface*);

      virtual void removeSpotReportHandler(const std::string& s);

      virtual bool addOrUpdateSpotReport(const std::string& type, void* data, const DtUUID&);

      virtual void removeSpotReport(makVrv::DtUniqueID id);

      virtual void removeAllSpotReports();

      virtual void resetFlushDataTime();

      virtual std::set<makVrv::DtUniqueID> observing(makVrv::DtUniqueID) const;

      virtual void setSuspended(bool);
      bool suspended() const
      {
         return mySuspended;
      }

      virtual double simTime() const;

      virtual bool isSpotReport(makVrv::DtUniqueID id) const;

      virtual DtSimObjectReference lookup(const DtUUID&) const;

   protected:
      virtual DtSpotReportDataHandler* createSpotReportHandler(const std::string& s, makVrv::DtUniqueID) const;

      virtual bool createSpotReport(const std::string& type, void* data, const DtUUID&);

   protected:
      virtual void processForceUpdateList();

      virtual void slot_localObjectRemoved(DtGuiLocalObject*);

      virtual void tick();

      virtual void updateFlushTime();
      virtual void updatePendingReports();
      virtual DtVrfSimBackendManager& backendManager() const;

   protected:
      DtSpotReportDataProcessor(makVrv::DtDe& sim);

      virtual ~DtSpotReportDataProcessor() override;

   protected:
      typedef std::set<makVrv::DtUniqueID> SpotReportIdList;
      typedef std::map<std::string, DtSpotReportDataHandlerCreatorInterface*> SpotReportHandlerCreators;
      typedef std::map<DtUUID, DtSpotReportDataHandler*> SpotReportHandlers;
      typedef std::map<makVrv::DtUniqueID, DtSpotReportDataHandler*> SpotReportHandlersById;

      makVrv::DtDe&  myDe;
      makVrv::DtSignalConnectionManager myConnections;
      SpotReportIdList myForceUpdateList;
      SpotReportHandlerCreators   mySpotReportHandlerCreators;
      SpotReportHandlers   mySpotReportHandlers;
      SpotReportHandlersById mySpotReportHandlersById;

      SpotReportHandlersById myNeedsUpdateOnAdd;

      double myNextFlushDataTime;
      mutable DtVrfSimBackendManager* myBackendManager;

      int myPauseFlushUpdate;
      bool mySuspended;

      struct PendingSpotReport
      {
         PendingSpotReport() : report(0) {};
         PendingSpotReport(const PendingSpotReport& orig)
            : type(orig.type), key(orig.key), report(orig.report)
         {
         }

         PendingSpotReport& operator=(const PendingSpotReport& orig)
         {
            type = orig.type;
            key = orig.key;
            report = orig.report;

            return *this;
         }

         virtual ~PendingSpotReport() {};
         std::string type;
         DtUUID key;
         DtSpotReport* report;
      };

      typedef std::vector<PendingSpotReport> PendingSpotReports;
      
      PendingSpotReports myPendingSpotReports;

      std::set<makVrv::DtUniqueID> myPendingReportsToFlushData;
   };
}