remoteConfigurationList.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2024 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/

#pragma once


#include <readerWriter/readerWriter.h>

#include <map>

#include "vrfutil/remoteConfigurationEntry.h"

#include "vrfutil/vrfutilDefines.h"
class DT_DLL_vrfutil DtRemoteConfigurationList : public DtReaderWriter
{
public:

   typedef DtRemoteConfigurationList* (*CreatorFcn)(const DtString& name, 
      DtReaderWriterRegistry* parentRegistry);

   typedef std::map< std::string, DtRemoteConfigurationEntry* > ConfigMap;
   typedef ConfigMap::iterator ConfigIterator;
   typedef ConfigMap::const_iterator const_ConfigIterator;

public:
   DtRemoteConfigurationList();

   DtRemoteConfigurationList(const DtString& name, 
      DtReaderWriterRegistry* parentRegistry = NULL, 
      bool readonly = false);

   DtRemoteConfigurationList(const DtSymbolString& name, 
      DtReaderWriterRegistry* parentRegistry = NULL, 
      bool readonly = false);

   DtRemoteConfigurationList(const DtString& name, 
      const DtRemoteConfigurationList& orig,
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtRemoteConfigurationList(const DtSymbolString& name, 
      const DtRemoteConfigurationList& orig,
      DtReaderWriterRegistry* parentRegistry = NULL);

   virtual ~DtRemoteConfigurationList() override;

public:
   const DtRemoteConfigurationList& operator=(const DtRemoteConfigurationList& orig);

   const DtRemoteConfigurationList& operator+=(const DtRemoteConfigurationList& orig);

public:

   virtual void add(DtRemoteConfigurationEntry* pEntry);

   virtual void add(const DtRemoteConfigurationEntry& entry, bool replace = true);

   DtRemoteConfigurationList::ConfigIterator begin();
   DtRemoteConfigurationList::const_ConfigIterator begin() const;

   virtual void append(const DtRemoteConfigurationList& orig);

   virtual bool appendFile(const DtFilename& fname, const DtReaderWriter::SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings);

   virtual void clear();

   DtRemoteConfigurationList::ConfigMap& configurationMap();
   const DtRemoteConfigurationList::ConfigMap& configurationMap() const;
   
   unsigned size() const;

   virtual void copyMap(const DtRemoteConfigurationList& orig);

   DtRemoteConfigurationEntry::CreatorFcn entryCreatorFcn() const;
   void setEntryCreatorFcn(DtRemoteConfigurationEntry::CreatorFcn fcn);

   DtRemoteConfigurationList::ConfigIterator end();
   DtRemoteConfigurationList::const_ConfigIterator end() const;

   virtual bool readFile(const DtFilename& fname, const DtReaderWriter::SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings);

   virtual void remove(DtRemoteConfigurationEntry *pEntry);
   virtual void remove(const char *pKeyName);

public:

   static DtRemoteConfigurationList* create(const DtString& name, 
      DtReaderWriterRegistry* parentRegistry);

protected:

   virtual DtlObjPtr getData(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings) override;

   virtual void putData(std::string& fp, int indentLevel = 0) override;

protected:

   ConfigMap    myConfigMap;
   DtRemoteConfigurationEntry::CreatorFcn   myEntryCreatorFcn;
};

inline DtRemoteConfigurationList::ConfigIterator DtRemoteConfigurationList::begin() {return (myConfigMap.begin());}
inline DtRemoteConfigurationList::const_ConfigIterator DtRemoteConfigurationList::begin() const {return (myConfigMap.begin());}

inline DtRemoteConfigurationList::ConfigMap& DtRemoteConfigurationList::configurationMap() {return (myConfigMap);}
inline const DtRemoteConfigurationList::ConfigMap& DtRemoteConfigurationList::configurationMap() const {return (myConfigMap);}

inline unsigned DtRemoteConfigurationList::size() const {return (myConfigMap.size());}

inline DtRemoteConfigurationEntry::CreatorFcn DtRemoteConfigurationList::entryCreatorFcn() const {return (myEntryCreatorFcn);}
inline void DtRemoteConfigurationList::setEntryCreatorFcn(DtRemoteConfigurationEntry::CreatorFcn fcn) {myEntryCreatorFcn = fcn;}

inline DtRemoteConfigurationList::ConfigIterator DtRemoteConfigurationList::end() {return (myConfigMap.end());}
inline DtRemoteConfigurationList::const_ConfigIterator DtRemoteConfigurationList::end() const {return (myConfigMap.end());}