BasicParameter.h

Go to the documentation of this file.

 
#ifndef MODELFITTING_BASICPARAMETER_H
#define MODELFITTING_BASICPARAMETER_H
 
#include <functional>    // for std::function of the parameter observer
#include <map>           // for std::map
#include <memory>
 
namespace ModelFitting {

class BasicParameter {
 
public:
 
  /*
   * Observers are functions
   */
  using ParameterObserver = std::function<void(double)>;
 
  virtual ~BasicParameter();
 
  BasicParameter(const BasicParameter&) = delete;
  BasicParameter& operator=(const BasicParameter&) = delete;
  BasicParameter(BasicParameter&&) = delete;
  BasicParameter& operator=(BasicParameter&&) = delete;
 
  /*
   * @brief Getter to access the private parameter value
   */
  virtual double getValue() const {
    return m_value;
  }

  std::size_t addObserver(ParameterObserver observer);
  
  bool removeObserver(std::size_t id);
 
  bool isObserved() const;
 
protected:
  typedef std::function<void(void)> GetValueHook;
 
  GetValueHook m_get_value_hook;
 
  explicit BasicParameter(const double value) :
      m_value(value) {
  }
 
  /*
   * @brief Setter for the new value, which also notify the
   * observers, by calling them with the new value.
   */
  virtual void setValue(const double new_value);
 
protected:
  double m_value;
 
private:
  std::map<std::size_t, ParameterObserver> m_observer_map;
  std::size_t m_last_obs_id = 0;
};
 
}
 
#endif  /* MODELFITTING_BASICPARAMETER_H */