vrfBackendState.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiCore/vrfGuiCore.h>
#include <vlpi/simulationAddress.h>
#include <boost/signals2.hpp>

#include <map>

#include <vrfutil/backend.h>

#include <boost/signals2.hpp>

namespace makVrv
{
   class DtMessage;
   class DtDe;
}

class DtSimMessage;

namespace makVrf 
{
   enum DtBackendChangedStates
   {
      DtBackendLoadedState =     0x00000001,
      DtBackendSimTime =         0x00000002,
      DtBackendExerciseTime =    0x00000004,
      DtBackendCanSimulate =     0x00000008,
      DtBackendControlState =    0x00000010,
      DtBackendSaving =          0x00000020,
      DtBackendAdded =           0x00000040,
      DtBackendRemoved =         0x00000080,
      DtBackendLoadedNewScenario = 0x00000100,
      DtBackendTimeMultiplier = 0x00000200,
      DtBackendRunDurationTime = 0x00000400,
      DtBackendClosedState =     0x00000800,
      DtBackendLoadingScenario =     0x00001000,
      DtBackendClosingScenario =     0x00002000,
      DtBackendDoneLoadingScenario =     0x00004000,
      DtBackendImportingScenario =     0x00008000,
      DtBackendDoneImportingScenario =     0x00010000,
      DtBackendObjectCount =     0x00020000,
      DtBackendCreatingSimulationObjectGroup =     0x00040000,
      DtBackendDoneCreatingSimulationObjectGroup =     0x00080000,
      DtBackendRollingBackScenario =     0x00100000,
      DtBackendRolledBackState =     0x00200000,
      DtBackendScenarioCapabilities =     0x00400000,
      DtHostingDynamicTerrainServer = 0x00800000,
      DtBackendChangedScenarioFilename = 0x01000000,
      DtBackendReinitializingScenario = 0x02000000,
      DtBackendDoneReinitializingScenario = 0x04000000
   };

   class DT_DLL_VRFGUICORE DtVrfBackendState
   {
   public:
      DtVrfBackendState(makVrv::DtDe& de)
      : mySaving(false)
      , myDe(de)
      , myFrameRateReportPeriod(3)
      , mySampleSize(50)
      , myMonitoringReference(0)
      , mySimTimeToRealTimeRatio(0)
      , myNumberOfCPUs(0)
      , myNumberOfTickThreads(0)
      , myTickingPublishersDuringObjectTick(false)
      {
      }

      DtVrfBackendState(makVrv::DtDe& de, const DtBackend& b)
      : myBackend(b)
      , myDe(de)
      , mySaving(false)
      , myFrameRateReportPeriod(3)
      , mySampleSize(50)
      , myMonitoringReference(0)
      , mySimTimeToRealTimeRatio(0)
      , myNumberOfCPUs(0)
      , myNumberOfTickThreads(0)
      , myTickingPublishersDuringObjectTick(false)
      {
      }

      DtVrfBackendState(const DtVrfBackendState& o)
      : myBackend(o.myBackend)
      , mySaving(o.mySaving)
      , myDe(o.myDe)
      , mySectionTimes(o.mySectionTimes)
      , mySimTimeToRealTimeRatio(o.mySimTimeToRealTimeRatio)
      , myNumberOfCPUs(o.myNumberOfCPUs)
      , myNumberOfTickThreads(o.myNumberOfTickThreads)
      , myTickingPublishersDuringObjectTick(o.myTickingPublishersDuringObjectTick)
      {
         if (o.myMonitoringReference)
         {
            myMonitoringReference = o.myMonitoringReference;
            (*myMonitoringReference)++;
         }
      }

      virtual ~DtVrfBackendState();

      DtVrfBackendState& operator=(const DtVrfBackendState& rhs);

      DtBackend::Status status() const
      {
         return myBackend.status();
      }

      std::string displayName() const
      {
         return myBackend.address().string();
      }

      const DtBackend& backend() const
      {
         return myBackend;
      }

      DtBackend& backend()
      {
         return myBackend;
      }

      void setBackend(const DtBackend& b)
      {
         myBackend = b;
      }

      void setSaving(bool b)
      {
         mySaving = b;
      }

      bool saving() const
      {
         return mySaving;
      }
      
      void setNumberOfCPUs(short s)
      {
         myNumberOfCPUs = s;
      }
      
      void setTickingPublishersDuringObjectTick(bool s)
      {
         myTickingPublishersDuringObjectTick = s;
      }

      void setNumberOfTickThreads(short s)
      {
         myNumberOfTickThreads = s;
      }

      virtual void startFrameRateMonitor(double period = -1);
      virtual void stopFrameRateMonitor();

      boost::signals2::signal<void (const DtVrfBackendState&)> signal_frameRatesUpdated;

   public:
      int numSections() const;
      int section(int);
      double frameRateMean(int section = -1) const;
      double frameRateMedian(int section = -1) const;
      double frameRateStandardDeviation(int section = -1) const;
      double frameRateMin(int section = -1) const;
      double frameRateMax(int section = -1) const;
      
      double frameRateSimTimeToRealTimeRatio() const
      {
         return mySimTimeToRealTimeRatio;
      }

      const DtBackend::SectionTimes& sectionTimes() const
      {
         return mySectionTimes;
      }

      bool tickingPublishersDuringObjectTick() const
      {
         return myTickingPublishersDuringObjectTick;
      }

      short numberOfCPUs() const
      {
         return myNumberOfCPUs;
      }

      short numberOfTickThreads() const
      {
         return myNumberOfTickThreads;
      }

   protected:
      virtual void processFrameRateCallback(DtSimMessage * msg);

   protected:
      makVrv::DtDe&  myDe;
      DtBackend      myBackend;
      bool           mySaving;
      double         myFrameRateReportPeriod;
      int            mySampleSize;
      int*           myMonitoringReference;

      DtBackend::SectionTimes mySectionTimes;
      double mySimTimeToRealTimeRatio;
      short myNumberOfCPUs;
      short myNumberOfTickThreads;
      bool myTickingPublishersDuringObjectTick;
   };

   DT_DLL_VRFGUICORE makVrv::DtMessage& operator<<( makVrv::DtMessage& msg,const DtVrfBackendState& state );

   DT_DLL_VRFGUICORE makVrv::DtMessage& operator>>( makVrv::DtMessage& msg, DtVrfBackendState& state );
}