AbstractParametrizable.h

Go to the documentation of this file.

//
// File: AbstractParametrizable.h
// Authors:
//   Julien Dutheil
// Created: 2009-03-29 09:10:00
//
 
/*
  Copyright or © or Copr. Bio++ Development Team, (November 19, 2004)
  
  This software is a computer program whose purpose is to provide classes
  for numerical calculus.
  
  This software is governed by the CeCILL license under French law and
  abiding by the rules of distribution of free software. You can use,
  modify and/ or redistribute the software under the terms of the CeCILL
  license as circulated by CEA, CNRS and INRIA at the following URL
  "http://www.cecill.info".
  
  As a counterpart to the access to the source code and rights to copy,
  modify and redistribute granted by the license, users are provided only
  with a limited warranty and the software's author, the holder of the
  economic rights, and the successive licensors have only limited
  liability.
  
  In this respect, the user's attention is drawn to the risks associated
  with loading, using, modifying and/or developing or reproducing the
  software by the user in light of its specific status of free software,
  that may mean that it is complicated to manipulate, and that also
  therefore means that it is reserved for developers and experienced
  professionals having in-depth computer knowledge. Users are therefore
  encouraged to load and test the software's suitability as regards their
  requirements in conditions enabling the security of their systems and/or
  data to be ensured and, more generally, to use and operate it in the
  same conditions as regards security.
  
  The fact that you are presently reading this means that you have had
  knowledge of the CeCILL license and that you accept its terms.
*/
 
#ifndef BPP_NUMERIC_ABSTRACTPARAMETRIZABLE_H
#define BPP_NUMERIC_ABSTRACTPARAMETRIZABLE_H
 
 
#include "Parametrizable.h"
 
// From the STL:
#include <map>
 
namespace bpp
{
class AbstractParametrizable :
  public virtual Parametrizable
{
private:
  ParameterList parameters_;
  std::string prefix_;
 
public:
  AbstractParametrizable(const std::string& prefix) : parameters_(), prefix_(prefix) {}
 
  virtual ~AbstractParametrizable() {}
 
public:
  bool hasParameter(const std::string& name) const { return parameters_.hasParameter(prefix_ + name); }
 
  const ParameterList& getParameters() const { return parameters_; }
 
  const Parameter& getParameter(const std::string& name) const
  {
    return parameters_.getParameter(prefix_ + name);
  }
 
  const std::shared_ptr<Parameter>& getSharedParameter(const std::string& name) const
  {
    return parameters_.getSharedParameter(prefix_ + name);
  }
 
  double getParameterValue(const std::string& name) const
  {
    return getParameter(name).getValue();
  }
 
  void setAllParametersValues(const ParameterList& parameters)
  {
    parameters_.setAllParametersValues(parameters);
    fireParameterChanged(parameters);
  }
 
  void setParameterValue(const std::string& name, double value)
  {
    parameters_.setParameterValue(prefix_ + name, value);
    fireParameterChanged(parameters_.createSubList(prefix_ + name));
  }
 
  void setParametersValues(const ParameterList& parameters)
  {
    parameters_.setParametersValues(parameters);
    fireParameterChanged(parameters);
  }
 
  bool matchParametersValues(const ParameterList& parameters)
  {
    std::unique_ptr< std::vector<size_t> > updatedParameters(new std::vector<size_t>());
    bool test = parameters_.matchParametersValues(parameters, updatedParameters.get());
    if (test)
      fireParameterChanged(parameters.shareSubList(*updatedParameters));
    return test;
  }
 
  size_t getNumberOfParameters() const { return parameters_.size(); }
 
  void setNamespace(const std::string& prefix);
 
  std::string getNamespace() const { return prefix_; }
 
  std::string getParameterNameWithoutNamespace(const std::string& name) const;
 
  virtual void fireParameterChanged(const ParameterList& parameters) {}
 
protected:
  virtual void addParameter_(Parameter* parameter)
  {
    if (parameter)
      parameters_.addParameter(parameter);
  }
 
  virtual void addParameters_(const ParameterList& parameters)
  {
    parameters_.addParameters(parameters);
  }
 
  virtual void shareParameter_(const std::shared_ptr<Parameter>& parameter)
  {
    parameters_.shareParameter(parameter);
  }
 
  virtual void shareParameters_(const ParameterList& parameters)
  {
    parameters_.shareParameters(parameters);
  }
 
  virtual void includeParameters_(const ParameterList& parameters)
  {
    parameters_.includeParameters(parameters);
  }
 
  virtual void deleteParameter_(size_t index)
  {
    if (index >= parameters_.size())
      throw IndexOutOfBoundsException("AbstractParametrizable::deleteParameter_.", index, 0, parameters_.size() - 1);
    parameters_.deleteParameter(index);
  }
 
  virtual void deleteParameter_(std::string& name)
  {
    parameters_.deleteParameter(name);
  }
 
  virtual void deleteParameters_(const std::vector<std::string>& names)
  {
    parameters_.deleteParameters(names);
  }
 
  void resetParameters_()
  {
    parameters_.reset();
  }
 
  Parameter& getParameter_(const std::string& name)
  {
    if (!hasParameter(name))
      throw ParameterNotFoundException("AbstractParametrizable::getParameter_().", prefix_ + name);
    return parameters_.getParameter(prefix_ + name);
  }
 
  Parameter& getParameterWithNamespace_(const std::string& name)
  {
    return getParameter_(name);
  }
  const Parameter& getParameterWithNamespace_(const std::string& name) const
  {
    return getParameter(name);
  }
 
  Parameter& getParameter_(size_t index)
  {
    if (index >= parameters_.size())
      throw IndexOutOfBoundsException("AbstractParametrizable::getParameter_.", index, 0, parameters_.size() - 1);
    return parameters_[index];
  }
 
  const Parameter& getParameter_(size_t index) const
  {
    if (index >= parameters_.size())
      throw IndexOutOfBoundsException("AbstractParametrizable::getParameter_.", index, 0, parameters_.size() - 1);
    return parameters_[index];
  }
 
 
  ParameterList& getParameters_() { return parameters_; }
 
  const std::shared_ptr<Parameter>& getSharedParameter(size_t i) const
  {
    return parameters_.getSharedParameter(i);
  }
 
  std::shared_ptr<Parameter>& getSharedParameter(size_t i)
  {
    return parameters_.getSharedParameter(i);
  }
};
} // end of namespace bpp.
#endif // BPP_NUMERIC_ABSTRACTPARAMETRIZABLE_H