scenarioPerformanceTestManager.h

Go to the documentation of this file.

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

#pragma once

#include "vrfcgf/vrfcgfDefines.h"
#include "vrfobjcore/simObjectReference.h"
#include <vrfutil/rwScenarioPerformanceTestConfig.h>

#include <chrono>
#include <atomic>

#include <rapidjson/fwd.h>

class DtCgf;
class DtScenario;
class DtLocalObject;

class DT_DLL_vrfcgf DtScenarioPerformanceTestManager
{
public:
   enum DtRandomCoordGenerationStatus
   {
      DtCoordInside = 0,
      DtCoordNotInside = 1,
      DtCoordIntersects = 2
   };

   struct DtPerformanceStatistics
   {
      int sampleNumber;
      double meanFramerate;
      double standardDeviationFramerate;
      double minimumFramerate;
      double maximumFramerate;
      double sampleTime;
   };

   struct DtEntityInfo
   {
      std::string EntityType;
      int numEntities;

      bool operator==(const DtEntityInfo& rhs) const { return ( EntityType == rhs.EntityType && numEntities == rhs.numEntities ); };
   };
   
   DtScenarioPerformanceTestManager(DtCgf* cgf, const DtString&, const DtString outputFilename = "");

   virtual ~DtScenarioPerformanceTestManager();

   DtScenarioPerformanceTestManager(const DtScenarioPerformanceTestManager&) = delete;

   DtScenarioPerformanceTestManager& operator=(const DtScenarioPerformanceTestManager&) = delete;

   static void postScenarioCloseCallback(void* usr);
   virtual void postScenarioCloseCallback();
   static void postScenarioLoadCallback(const DtScenario& s, void* usr);
   virtual void postScenarioLoadCallback(const DtScenario& s);
   static void postTickCallback(void* usr);
   static void endBulkCreateCallback(void* usr);
   virtual void endBulkCreateCallback();
   virtual void tick();

   bool loadScenario();

   void setMaxTasks();

   bool jsonPrettyPrint() { return myRapidjsonPrettyPrint; };
   void setJsonPrettyPrint(bool pp) { myRapidjsonPrettyPrint = pp; };

   int jsonDecimals() { return myRapidjsonDecimals; };
   void setJsonDecimals(int d) { myRapidjsonDecimals = d; };

   int jsonIndentSize() { return myRapidjsonIndentSize; };
   void setJsonIndentSize(int s) { myRapidjsonIndentSize = s; };

   DtRandomCoordGenerationStatus generateRandomPointInArea(DtSimObjectReference area, const double entityRadius, DtExtent& areaExtent, DtVector& coord,
      const std::vector<DtVector>& checkPositions = std::vector<DtVector>());

protected:
   void loadConfig(const DtString&);

   void finishMonitoring();

   int checkTestName(const rapidjson::Value&) const;
   bool checkEntityInfo(const rapidjson::Value&, const std::vector<DtEntityInfo>) const;
   bool checkScenarioFile(const rapidjson::Value&) const;
   bool checkProtocol(const rapidjson::Value&) const;
   bool checkCallbackThreads(const rapidjson::Value&) const;

   void createJsonFile();

   void createEntities(const DtRwEntityCreationConfig& config, std::vector<DtLocalObject*>& ents);
   DtExtent generateExtentsOfArea(DtSimObjectReference area);

   std::string getCurrentProtocol() const;

   std::string getCPUName() const;
   double getMemoryInstalled() const;

protected:
   double myEntityCreationTime;
   std::vector<DtPerformanceStatistics> myStats;
   double myFinishedPostScenarioLoadTime;
   bool myDelayedStartSamplingTime;
   double myLastCheckedTime;
   int mySampleCount;

   bool myRapidjsonPrettyPrint;
   int myRapidjsonDecimals;
   int myRapidjsonIndentSize;
   std::string myOutputJson;
   unsigned int myCurrentFrame;
   unsigned int myMaxFrames;

   DtCgf* myCgf;
   DtRwScenarioPerformanceTestConfig myConfig;
};

DT_DLL_vrfcgf std::ostream& operator<<(std::ostream&, const DtScenarioPerformanceTestManager::DtPerformanceStatistics&);