Parameter.h

Go to the documentation of this file.

//
// File: Parameter.h
// Authors:
//   Julien Dutheil
// Created: 2003-10-15 15:40:47
//
 
/*
  Copyright or © or Copr. Bio++ Development Team, (November 17, 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_PARAMETER_H
#define BPP_NUMERIC_PARAMETER_H
 
 
#include "../Clonable.h"
#include "Constraints.h"
#include "ParameterExceptions.h"
 
// From the STL:
#include <string>
#include <iostream>
#include <vector>
#include <memory>
 
namespace bpp
{
class Parameter;
 
class ParameterEvent :
  public virtual Clonable
{
protected:
  Parameter* parameter_;
 
public:
  ParameterEvent(Parameter* parameter);
 
  ParameterEvent(const ParameterEvent& pe) : parameter_(pe.parameter_) {}
  ParameterEvent& operator=(const ParameterEvent& pe)
  {
    parameter_ = pe.parameter_;
    return *this;
  }
 
  ParameterEvent* clone() const { return new ParameterEvent(*this); }
 
public:
  const Parameter* getParameter() const { return parameter_; }
  Parameter* getParameter() { return parameter_; }
};
 
class ParameterListener :
  public virtual Clonable
{
public:
  ParameterListener* clone() const = 0;
 
public:
  virtual const std::string& getId() const = 0;
 
  virtual void parameterNameChanged(ParameterEvent& event) = 0;
 
  virtual void parameterValueChanged(ParameterEvent& event) = 0;
 
  virtual void parameterConstraintChanged(ParameterEvent& event) = 0;
};
 
class Parameter :
  public virtual Clonable
{
protected:
  std::string name_;             // Parameter name
  double value_;            // Parameter value
  double precision_;  // Precision needed for Parameter value
  std::shared_ptr<Constraint> constraint_;
  std::vector<ParameterListener*> listeners_;
  std::vector<bool> listenerAttach_;
 
public:
  // Class constructors and destructors:
 
  Parameter() : name_(""), value_(0), precision_(0), constraint_(0), listeners_(), listenerAttach_() {}
 
  Parameter(const std::string& name, double value, std::shared_ptr<Constraint> constraint = 0, double precision = 0);
 
  Parameter(const std::string& name, double value, std::shared_ptr<Constraint> constraint, bool precision) = delete;
 
  Parameter(const Parameter& param);
 
  Parameter& operator=(const Parameter& param);
 
  virtual ~Parameter();
 
  Parameter* clone() const { return new Parameter(*this); }
 
public:
  virtual void setName(const std::string& name)
  {
    name_ = name;
    ParameterEvent event(this);
    fireParameterNameChanged(event);
  }
 
  virtual void setValue(double value);
 
  void setPrecision(double precision);
 
  virtual const std::string& getName() const { return name_; }
 
  virtual double getValue() const { return value_; }
 
  virtual double getPrecision() const { return precision_; }
 
  virtual const std::shared_ptr<Constraint> getConstraint() const { return constraint_; }
 
  virtual std::shared_ptr<Constraint> getConstraint() { return constraint_; }
 
  virtual bool hasConstraint() const { return constraint_ != 0; }
 
  virtual std::shared_ptr<Constraint> removeConstraint();
 
  virtual void setConstraint(std::shared_ptr<Constraint> constraint);
 
  virtual void addParameterListener(ParameterListener* listener, bool attachListener = true)
  {
    listeners_.push_back(listener);
    listenerAttach_.push_back(attachListener);
  }
 
  virtual void removeParameterListener(const std::string& listenerId);
 
  virtual bool hasParameterListener(const std::string& listenerId);
 
protected:
  void fireParameterNameChanged(ParameterEvent& event)
  {
    for (std::vector<ParameterListener*>::iterator it = listeners_.begin(); it != listeners_.end(); it++)
    {
      (*it)->parameterNameChanged(event);
    }
  }
 
  void fireParameterValueChanged(ParameterEvent& event)
  {
    for (std::vector<ParameterListener*>::iterator it = listeners_.begin(); it != listeners_.end(); it++)
    {
      (*it)->parameterValueChanged(event);
    }
  }
 
  void fireParameterConstraintChanged(ParameterEvent& event)
  {
    for (std::vector<ParameterListener*>::iterator it = listeners_.begin(); it != listeners_.end(); it++)
    {
      (*it)->parameterConstraintChanged(event);
    }
  }
 
public:
  static const std::shared_ptr<IntervalConstraint> R_PLUS;
  static const std::shared_ptr<IntervalConstraint> R_PLUS_STAR;
  static const std::shared_ptr<IntervalConstraint> R_MINUS;
  static const std::shared_ptr<IntervalConstraint> R_MINUS_STAR;
  static const std::shared_ptr<IntervalConstraint> PROP_CONSTRAINT_IN;
  static const std::shared_ptr<IntervalConstraint> PROP_CONSTRAINT_EX;
};
} // end of namespace bpp.
#endif // BPP_NUMERIC_PARAMETER_H