Parametrizable.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: The Bio++ Development Group
//
// SPDX-License-Identifier: CECILL-2.1

#ifndef BPP_NUMERIC_PARAMETRIZABLE_H
#define BPP_NUMERIC_PARAMETRIZABLE_H


// From Utils:
#include "../Clonable.h"

// From the STL:
#include <string>

#include "ParameterList.h"

namespace bpp
{
class Parametrizable :
  public virtual Clonable
{
public:
  Parametrizable() {}
  virtual ~Parametrizable() {}

public:
  virtual bool hasParameter(const std::string& name) const = 0;

  virtual const ParameterList& getParameters() const = 0;

  virtual const Parameter& parameter(const std::string& name) const = 0;

  virtual double getParameterValue(const std::string& name) const
  = 0;

  virtual void setAllParametersValues(const ParameterList& parameters) = 0;

  virtual void setParameterValue(const std::string& name, double value) = 0;

  virtual void setParametersValues(const ParameterList& parameters) = 0;

  virtual bool matchParametersValues(const ParameterList& parameters) = 0;

  virtual void removeConstraint(const std::string& name) = 0;

  virtual void setConstraint(const std::string& name, std::shared_ptr<ConstraintInterface> constraint) = 0;

  virtual size_t getNumberOfParameters() const = 0;

  virtual void setNamespace(const std::string& prefix) = 0;

  virtual std::string getNamespace() const = 0;

  virtual std::string getParameterNameWithoutNamespace(const std::string& name) const = 0;

protected:
  virtual ParameterList& getParameters_() = 0;
};

class ParametrizableAdapter :
  public virtual Parametrizable
{
protected:
  ParameterList parameters_;
  Parameter parameter_;

public:
  ParametrizableAdapter() : parameters_(), parameter_() {}
  virtual ~ParametrizableAdapter() {}

public:
  bool hasParameter(const std::string& name) const override { return parameters_.hasParameter(name); }
  const ParameterList& getParameters() const override { return parameters_; }
  const Parameter& parameter(const std::string& name) const override { return parameter_; }
  double getParameterValue(const std::string& name) const override { return 0; }
  void setAllParametersValues(const ParameterList& parameters) override {}
  void setParameterValue(const std::string& name, double value) override {}
  void setParametersValues(const ParameterList& parameters) override {}
  bool matchParametersValues(const ParameterList& parameters) override { return false; }
  void removeConstraint(const std::string& name) override {}
  void setConstraint(const std::string& name, std::shared_ptr<ConstraintInterface> constraint) override {}
  size_t getNumberOfParameters() const override { return 0; }
  void setNamespace(const std::string& prefix) override {}
  std::string getNamespace() const override { return ""; }
  std::string getParameterNameWithoutNamespace(const std::string& name) const override { return name; }
};
} // end of namespace bpp.
#endif // BPP_NUMERIC_PARAMETRIZABLE_H