Steerable.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_Steerable_h
#define CepGen_Core_Steerable_h
 
#include "CepGen/Core/ParametersDescription.h"
 
namespace cepgen {
  class Steerable {
  public:
    explicit Steerable(const ParametersList&);  
    virtual ~Steerable() = default;
 
    static ParametersDescription description();  
 
    inline virtual const ParametersList& parameters() const { return params_; }  
    virtual void setParameters(const ParametersList&);                           
 
  protected:
    template <typename T>
    inline T steer(const std::string& key) const {
      return params_.get<T>(key);
    }
    template <typename T, typename U>
    inline U steerAs(const std::string& key) const {
      return params_.getAs<T, U>(key);
    }
    inline std::string steerName() const { return steer<std::string>(MODULE_NAME); }
    std::string steerPath(const std::string& key) const;  
    mutable ParametersList params_;                       
  };
}  // namespace cepgen
 
#endif