DtEnvironmentList.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/vrvCore.h>
#include <vrvCore/DtRecordSettingsBackup.h>

#include <list>
#include <string>
#include <vector>

namespace makArchives
{
   class DtEnvironmentListRecord;
   class DtEnvironmentRecord;
}

namespace makVrv
{
   class DtDe;

   class DT_DLL_VRVCORE DtEnvironmentList
   {
   public:

      DtEnvironmentList(DtDe& de);

      virtual ~DtEnvironmentList();

      void getRecord(makArchives::DtEnvironmentListRecord& record) const;

      void setFromRecord(
         const makArchives::DtEnvironmentListRecord& record);

      void getEnvironmentNames(std::vector<std::string>& names, 
         bool includeLocalOnlyEnvironment=false) const;

      void setEnvironmentNames(const std::vector<std::string>& names);

      const makArchives::DtEnvironmentRecord&
         getEnvironment(const std::string& name) const;

      makArchives::DtEnvironmentRecord&
         getEnvironment(const std::string& name);

      void addOrReplaceEnvironment(
         const makArchives::DtEnvironmentRecord& environment);

      void removeEnvironment(const std::string& name);

      void renameEnvironment(
         const std::string& oldName, const std::string& newName);


      const makArchives::DtEnvironmentRecord& getDefaultEnvironment() const;

      void setDefaultEnvironment(
         const makArchives::DtEnvironmentRecord& environment);

      const std::string& getDefaultEnvironmentName() const;

      void setDefaultEnvironment(const std::string& name);
      // @}

      void loadDefaults(bool loadOnlyFactorySettings = false);

      void restore();

      void saveAsDefaults();

      void exportSettings(const std::string& filename);
      void importSettings(const std::string& filename);

      const DtSettingsBackup* settingsBackup() const;
      DtSettingsBackup* settingsBackup();

   protected:

      DtEnvironmentList();

      virtual void saveEnvironmentList();

   protected:
      static const std::string myFileName;

      DtDe& myDe;
      DtRecordSettingsBackupInterface* mySettingsBackup;

      typedef std::list<makArchives::DtEnvironmentRecord> SettingsList;

      SettingsList mySettingsList;
      std::string myDefaultConditionName;
   };

   typedef DtRecordSettingsBackup<DtEnvironmentList, makArchives::DtEnvironmentListRecord> DtEnvironmentListSettingsBackup;
}