ParametersDescription.h

Go to the documentation of this file.

/*
 *  CepGen: a central exclusive processes event generator
 *  Copyright (C) 2021-2024  Laurent Forthomme
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef CepGen_Core_ParametersDescription_h
#define CepGen_Core_ParametersDescription_h
 
#include "CepGen/Core/ParametersList.h"
 
namespace cepgen {
  class ParametersDescription : private ParametersList {
  public:
    explicit ParametersDescription(const std::string& mod_key = "");
    explicit ParametersDescription(const ParametersList& params);
 
    bool empty() const;
    ParametersDescription& operator+=(const ParametersDescription&);
    friend std::ostream& operator<<(std::ostream&, const ParametersDescription&);
    template <typename I>
    ParametersDescription& setKey(const I& key) {
      mod_key_ = std::to_string(key);
      return *this;
    }
    const std::string& key() const { return mod_key_; }
    ParametersDescription& setDescription(const std::string& descr);
    const std::string& description() const { return mod_descr_; }
    ParametersDescription& setParametersVector(bool pv = true) {
      is_vec_params_ = pv;
      return *this;
    }
    template <typename T>
    ParametersDescription& add(const std::string& name, const T& def) {
      if (obj_descr_.count(name) == 0)
        // only add a new, empty description if not yet described
        // (allows to ensure previous descriptions are not discarded)
        obj_descr_[name] = ParametersDescription();
      ParametersList::set<T>(name, def);
      return obj_descr_[name];
    }
    template <typename T, typename U>
    inline ParametersDescription& addAs(const std::string& name, const U& def) {
      return add<T>(name, static_cast<T>(def));
    }
    inline ParametersDescription& setName(const std::string& name) {
      ParametersList::setName(name);
      return *this;
    }
    ParametersDescription& addParametersDescriptionVector(const std::string&,
                                                          const ParametersDescription&,
                                                          const std::vector<ParametersList>& def = {});
    std::string describe(size_t offset = 0) const;  
    ParametersList& parameters();                   
    const ParametersList& parameters() const;       
    bool has(const std::string&) const;             
    const ParametersDescription& get(const std::string&) const;  
    ParametersList validate(const ParametersList&) const;        
    ParametersDescription steer(const ParametersList&) const;    
 
    enum struct Type { Value, Parameters, Module, ParametersVector };  
    friend std::ostream& operator<<(std::ostream&, const Type&);       
    Type type() const;                                                 
 
    class ParameterValues {
    public:
      ParameterValues() {}
 
      friend std::ostream& operator<<(std::ostream&, const ParameterValues&);
 
      ParameterValues& append(const ParameterValues&);         
      inline bool allAllowed() const { return all_allowed_; }  
      bool empty() const;  
 
      std::map<std::string, std::string> allowed() const;  
 
      bool validate(int) const;                 
      bool validate(const std::string&) const;  
 
    private:
      bool all_allowed_{true};
      std::map<int, std::string> int_vals_;
      std::map<std::string, std::string> str_vals_;
      friend ParametersDescription;
    };
    inline const ParameterValues& allowedValues() const { return obj_values_; }  
    ParametersDescription& allow(int, const std::string& = "");  
    ParametersDescription& allow(const std::string&,
                                 const std::string& = "");  
    void allowAll() { obj_values_.all_allowed_ = true; }    
 
  private:
    inline ParameterValues& allowedValues() { return obj_values_; }  
 
    std::string mod_key_, mod_descr_;
    bool is_vec_params_{false};
    std::map<std::string, ParametersDescription> obj_descr_;
    ParameterValues obj_values_;
  };
  template <>
  ParametersDescription& ParametersDescription::setKey<std::string>(const std::string&);
  template <>
  ParametersDescription& ParametersDescription::add(const std::string&, const ParametersDescription&);
  template <>
  ParametersDescription& ParametersDescription::add(const std::string&, const ParametersList&);
}  // namespace cepgen
 
#endif