vrfDatabaseEvent.h

Go to the documentation of this file.

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

#include <vrfMsgTransport/vrfMsgTransportDefines.h>
#include <vrfutil/uuid.h>
#include <vlutil/vlString.h>
#include <matrix/vlVector.h>
#include <vlpi/entityType.h>
#include <map>
#include <string>

class DtVrfDatabaseEventParam;

class DT_DLL_vrfMsgTransport DtVrfDatabaseEvent
{
public:

   enum EventType
   {
      UnknownEvent = 0,
      WakeupEvent = 1, 
      ShutdownEvent = 2, 
      InternalStatsEvent = 3, 
      SimEngineEvent = 4,
      ScenarioRunEvent = 5,
      DetonationEvent = 6,
      FireEvent = 7,
      DamageEvent = 8,
      ObjectEvent = 9,
      DetectionEvent = 10,
      ResourceEvent = 11,
      EngagementEvent = 12,
      EngagementAttackEvent = 13,
      EngagementDefenseEvent = 14,
      EngagementCasualtyReportEvent = 15,
      EngagementDamageReportEvent = 16,
      ScenarioEventEvent = 17,
      UserEvent = 500 
   };

   using ParamVector = std::vector<DtVrfDatabaseEventParam*>;

   static const bool PrimaryKey = true;

   enum TableUpdateFlag
   {
      InsertOrIgnore = 1, 
      InsertOrUpdate = 2, 
      UpdateExisting = 3  
   };

public:
   DtVrfDatabaseEvent(TableUpdateFlag updateRule = InsertOrIgnore);
   DtVrfDatabaseEvent(const DtVrfDatabaseEvent& orig);
   DtVrfDatabaseEvent(DtVrfDatabaseEvent&& orig) noexcept;

   virtual ~DtVrfDatabaseEvent();

   DtVrfDatabaseEvent& operator=(const DtVrfDatabaseEvent&);
   DtVrfDatabaseEvent& operator=(DtVrfDatabaseEvent&&) noexcept;

   virtual DtVrfDatabaseEvent::EventType eventType() const { return myEventType; };

   virtual void setEventType(DtVrfDatabaseEvent::EventType et) { myEventType = et; };

   virtual TableUpdateFlag updateOrInsert() const { return myUpdateOrInsert; };

   virtual DtVrfDatabaseEvent& addParameter(const DtString& name, bool p, bool isPrimaryKey = false);
   virtual DtVrfDatabaseEvent& addParameter(const DtString& name, int p, bool isPrimaryKey = false);
   virtual DtVrfDatabaseEvent& addParameter(const DtString& name, unsigned p, bool isPrimaryKey = false);
   virtual DtVrfDatabaseEvent& addParameter(const DtString& name, float p, bool isPrimaryKey = false);
   virtual DtVrfDatabaseEvent& addParameter(const DtString& name, double p, bool isPrimaryKey = false);
   virtual DtVrfDatabaseEvent& addParameter(const DtString& name, std::string&& p, bool isPrimaryKey = false);
   virtual DtVrfDatabaseEvent& addParameter(const DtString& name, const std::string& p, bool isPrimaryKey = false);
   virtual DtVrfDatabaseEvent& addParameter(const DtString& name, const DtString& p, bool isPrimaryKey = false);
   virtual DtVrfDatabaseEvent& addParameter(const DtString& name, const DtEntityType& p, bool isPrimaryKey = false);
   virtual DtVrfDatabaseEvent& addParameter(const DtString& name, const DtEntityIdentifier& p, bool isPrimaryKey = false);
   virtual DtVrfDatabaseEvent& addParameter(const DtString& name, const DtSimulationAddress& p, bool isPrimaryKey = false);
   virtual DtVrfDatabaseEvent& addParameter(const DtString& name, const DtUUID& p, bool isPrimaryKey = false);
   virtual DtVrfDatabaseEvent& addParameter(const DtString& name, const DtVector& p, bool isPrimaryKey = false);

   virtual const ParamVector& parameters() const { return myParams; };

   virtual bool hasParameter(const DtString& name) const;

   virtual void setCreateTableOnly(bool v);
   virtual bool createTableOnly() const;

   virtual void setExcludeDefaultScenarioParameters(bool v);
   virtual bool excludeDefaultScenarioParameters() const;

   static const std::string& eventTableName(EventType);

   static void initializeDefaultEventTypes();

   static void addEventType(unsigned eventType, const std::string& eventTableName);

   static std::map<EventType, std::string> eventTypeMapping();

   static const std::map<EventType, DtVrfDatabaseEvent>& eventPrototypes();

   static DtVrfDatabaseEvent::EventType highestEventType();

   static void setEventTypeMapping(const std::map<EventType, std::string>& mapping);

   static void setEventPrototypes(const std::map<EventType, DtVrfDatabaseEvent>& mapping);

protected:

   void copyParameters(const DtVrfDatabaseEvent& orig);

protected:
   DtVrfDatabaseEvent::EventType myEventType;
   TableUpdateFlag myUpdateOrInsert;
   bool myCreateTableOnly;
   bool myExcludeDefaultScenarioParameters;

   ParamVector myParams;

   static std::map<EventType, std::string> theEventTypeMapping;
   static std::map<EventType, DtVrfDatabaseEvent> theEventPrototypes;
};

using DtVrfDatabaseEventUniquePtr = std::unique_ptr<DtVrfDatabaseEvent>;
using DtVrfDatabaseEventVector = std::vector<DtVrfDatabaseEventUniquePtr>;