configuration.h

Go to the documentation of this file.

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


#pragma once

#include "legionDataStore/export.h"
#include "legionDataStore/dataTypes.h"

#include <string>
#include <map>

namespace Legion
{
   typedef UInt64 ConfigHandle;

   class LEGION_DLL Configuration
   {
   public:
      Configuration();

      Configuration(const std::string& fileName);

      virtual ~Configuration();

      virtual Configuration* clone() const;

      template<typename DATA_TYPE>
      void registerParameter(const std::string& string);

      virtual int processArguments(int argc, char** argv);

      virtual bool processParameters(const std::map<std::string, std::string>& parameterValuePairs);
      
      virtual bool hasParameter(const std::string& parameterName) const;

      virtual bool isParameterSet(const std::string& parameterName) const;

      virtual bool loadParameters(const std::string& fileName);

      virtual bool saveParameters(const std::string& filename) const;

      template<typename DATA_TYPE>
      void setParameter(const std::string& parameterName, DATA_TYPE parameterValue);

      template<typename DATA_TYPE>
      DATA_TYPE parameter(const std::string& parameterName) const;

      template<typename DATA_TYPE>
      DATA_TYPE parameterOr(const std::string& parameterName, DATA_TYPE defaultValue) const;

      virtual void setUnitMultiplier(const std::string& parameterName, float multiplier);

      virtual float unitMultiplier(const std::string& parameterName) const;

      virtual std::string helpString() const;

      ConfigHandle handle() const { return myHandle; }

   protected:
      ConfigHandle myHandle;

      //used by clone
      Configuration(ConfigHandle handle);

   };

   template<typename DATA_TYPE>
   DATA_TYPE Legion::Configuration::parameterOr(const std::string& parameterName, DATA_TYPE defaultValue) const
   {
      if (hasParameter(parameterName))
      {
         return parameter<DATA_TYPE>(parameterName);
      }

      return defaultValue;
   }
}