vrfPluginRecord.h

Go to the documentation of this file.

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



#pragma once

#include "vrfutil/vrfutilDefines.h"

#include <boost/serialization/access.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/list.hpp>
#include <boost/serialization/map.hpp>
#include <boost/serialization/vector.hpp>
#include <boost/serialization/string.hpp>

class DT_DLL_vrfutil DtVrfPluginRecord
{
public:
   typedef std::map<std::string, std::string>               PluginData;
   
   typedef std::map<std::string, PluginData>                TransportConfigurationMap;

   typedef std::map<std::string, TransportConfigurationMap>  BuildConfigurationMap;

   typedef std::map<std::string, BuildConfigurationMap>  PlatformMap;

   typedef std::map<std::string, PlatformMap>        PluginMap;

public:

   DtVrfPluginRecord();
   DtVrfPluginRecord(const DtVrfPluginRecord&);

   virtual ~DtVrfPluginRecord();

   virtual bool load(const std::string& file);

   virtual bool save(const std::string& file);
   virtual bool save();

   virtual const std::string& file() const;

   DtVrfPluginRecord& operator=(const DtVrfPluginRecord&);

   virtual std::string name() const;

   virtual bool rename(const std::string& newName);

   void setAutoSave(bool);
   bool autoSave() const;

public:
   void setApplication(const std::string& application);
   virtual const std::string& application() const;

   void setPlatform(const std::string& platform);
   virtual const std::string& platform() const;

   void setTransport(const std::string& transport);
   virtual const std::string& transport() const;

   void setConfiguration(const std::string&);
   virtual const std::string& configuration() const;

   virtual std::string value(const std::string& key) const;
   virtual std::string value(const std::string& application,
      const std::string& platform, const std::string& configuration, const std::string& transport, const std::string& key) const;

   virtual std::string plugin() const;
   virtual std::string plugin(const std::string& application,
      const std::string& platform, const std::string& configuration, const std::string& transport) const;

   virtual bool loadPlugin() const;
   virtual bool loadPlugin(const std::string& application,
      const std::string& platform, const std::string& configuration, const std::string& transport) const;

   virtual void setPlugin(const std::string&);
   virtual void setPlugin(const std::string& application,
      const std::string& platform, const std::string& configuration, const std::string& transport, const std::string& plugin);

   virtual PluginData pluginData() const;
   virtual PluginData pluginData(const std::string& application,
      const std::string& platform, const std::string& configuration, const std::string& transport) const;

   virtual void setPluginData(const std::string& key, const std::string& value);
   virtual void setPluginData(const std::string& application,
      const std::string& platform, const std::string& configuration, const std::string& transport, const std::string& key,
      const std::string& value);

   virtual bool removePlugin();
   virtual bool removePlugin(const std::string& application,
      const std::string& platform, const std::string& configuration, const std::string& transport);

   virtual bool addPlugin(const std::string& application,
      const std::string& platform, const std::string& configuration, const std::string& transport);

   virtual bool removePluginData(const std::string& key);
   virtual bool removePluginData(const std::string& application,
      const std::string& platform, const std::string& configuration, const std::string& transport, const std::string& key);

   const PluginMap& pluginStructure() const;

   void setLoad(bool);
   virtual bool load() const;

protected:
   virtual void clearConfigurationsFrom(const std::string& application);
   virtual void duplicateProtocolConfiguration(const std::string& application, const std::string& sourceProtocol, const std::string& destinationProtocol);
   virtual void removeProtocol(const std::string& application, const std::string& protocol);

protected:
   friend class boost::serialization::access;

   template<class Archive>
      void serialize(Archive & ar, const unsigned int version)
   {
      myVersion = version;
      ar & BOOST_SERIALIZATION_NVP(myPluginData);
      ar & BOOST_SERIALIZATION_NVP(myLoad);
   }

protected:
   PluginMap            myPluginData;
   unsigned int         myVersion = 2;
   std::string          myPlatform;
   std::string          myConfiguration;
   std::string          myTransport;
   std::string          myApplication;
   std::string          myFile;

   bool                 myLoad;
   bool                 myAutoSave;
};

BOOST_CLASS_VERSION(DtVrfPluginRecord, 3)