vrfDatabaseLoggerInterface.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2024 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
#pragma once

#include <vrfMsgTransport/vrfMsgTransportDefines.h>
#include <vrfMsgTransport/vrfDatabaseEvent.h>
#include <vrfMsgTransport/vrfDatabaseConnection.h>
#include <functional>
#include <vlpi/simulationAddress.h>

class DtRwDatabaseLoggerConfig;
class DtSimManager;

class DT_DLL_vrfMsgTransport DtVrfDatabaseLoggerInterface
{
public:

   virtual ~DtVrfDatabaseLoggerInterface();

   virtual void initialize(const DtRwDatabaseLoggerConfig& config, 
      const DtSimulationAddress& simAddress,
      std::unique_ptr<DtVrfDatabaseConnection> conn);

   virtual bool isEnabled() const = 0;

   virtual bool isEventEnabled(DtVrfDatabaseEvent::EventType eventType) const = 0;

   virtual bool logEvent(DtVrfDatabaseEvent::EventType eventType, const DtVrfDatabaseEvent& event) = 0;
   virtual bool logEvent(DtVrfDatabaseEvent::EventType eventType, DtVrfDatabaseEvent&& event) = 0;
    
   virtual bool logEvent(DtVrfDatabaseEvent::EventType eventType, std::function<DtVrfDatabaseEvent()> f) = 0;

   virtual std::unique_ptr<DtVrfDatabaseEvent> popEvent() = 0;

   virtual void setScenarioLoadInformation(int runId, const DtFilename& scenarioName,
      DtTime simTime);

   virtual void setScenarioRunInformation(const DtFilename& scenarioName,
      DtTime simTime, DtTime dateAndTimeOfDay, DtTime realWorldTime);

   virtual void tick(double simTime);

   virtual unsigned queueSize() { return 999999; };

   virtual void forceDatabaseUpdate() {};

   const DtVrfDatabaseConnection* databaseConnection() const;
   DtVrfDatabaseConnection* databaseConnection();

   virtual double resourceThresholdPercentage() const { return myResourceThresholdPercentage; };
   virtual void setResourceThresholdPercentage(double p) { myResourceThresholdPercentage = p; };

protected:

   DtVrfDatabaseLoggerInterface();

private:

   DtVrfDatabaseLoggerInterface(const DtVrfDatabaseLoggerInterface& other);

   DtVrfDatabaseLoggerInterface& operator=(const DtVrfDatabaseLoggerInterface& other);

protected:

   double myResourceThresholdPercentage;
   DtSimulationAddress mySimAddress;
   double mySimTime;
   double myDateAndTimeStart;
   double myRealWorldTimeStart;
   bool myScenarioRunInfoSet;
   int myRunId;
   DtString myScenarioName;
   double myLogPeriod;
   double myNextLogTime;

   std::unique_ptr<DtVrfDatabaseConnection> myDatabaseConnection;
};

class DT_DLL_vrfMsgTransport DtVrfDatabaseLoggerCreator
{
public:

   typedef DtVrfDatabaseLoggerInterface* (*DatabaseLoggerCreatorFcn)();
   typedef DtVrfDatabaseConnection* (*DatabaseConnectionCreatorFcn)();

   static DtVrfDatabaseLoggerInterface* createLoggerAndConnection(DtSimManager& simManager);

   static void setDatabaseLoggerCreatorFcn(const DtString& dbLoggerType,
      DatabaseLoggerCreatorFcn fcn);

   static void setDatabaseConnectionCreatorFcn(const DtString& dbConnType,
      DatabaseConnectionCreatorFcn fcn);

protected:

   static std::map<DtString, DatabaseLoggerCreatorFcn>& loggerCreators();
   static std::map<DtString, DatabaseConnectionCreatorFcn>& connectionCreators();

private:

   DtVrfDatabaseLoggerCreator();
   DtVrfDatabaseLoggerCreator(const DtVrfDatabaseLoggerCreator&);
   ~DtVrfDatabaseLoggerCreator();
};

class DT_DLL_vrfMsgTransport DtNullDatabaseLogger : public DtVrfDatabaseLoggerInterface
{
public:

   DtNullDatabaseLogger() : DtVrfDatabaseLoggerInterface() {};

   virtual ~DtNullDatabaseLogger() override {};

   virtual bool isEnabled() const override { return false; };

   virtual bool isEventEnabled(DtVrfDatabaseEvent::EventType eventType) const override { return false; };

   virtual bool logEvent(DtVrfDatabaseEvent::EventType eventType, const DtVrfDatabaseEvent& event) override
   { return true; };
   virtual bool logEvent(DtVrfDatabaseEvent::EventType eventType, DtVrfDatabaseEvent&& event) override { return true; };
   virtual bool logEvent(DtVrfDatabaseEvent::EventType eventType, std::function<DtVrfDatabaseEvent()> f) override
   { return true; };
   virtual std::unique_ptr<DtVrfDatabaseEvent> popEvent() override { return std::unique_ptr<DtVrfDatabaseEvent>(); };

   static DtVrfDatabaseLoggerInterface* create() { return new DtNullDatabaseLogger(); };

   static DtString type() { return "null-database-logger"; };

private:

   DtNullDatabaseLogger(const DtNullDatabaseLogger& other);

   DtNullDatabaseLogger& operator=(const DtNullDatabaseLogger& other);

};