/*
 * ModelPar.h
 *
 *  Created on: Jan 12, 2013
 *      Author: steve
 */

#ifndef MODELPAR_H_
#define MODELPAR_H_

#include <string>
#include <set>

#include "SharedPtr.h"

class ModelPar {
private:
  std::string name;
  double value;
  double lower_bound;
  double upper_bound;
  bool fixed, superior, set, locked, bounded;

  /**
   * This stores the connection to other ModelPar's. Once this ModelPar is
   * freed, the parametrizations (if they exist) of the connected parameters
   * are called at each iteration step. Note that a parameter can also have a
   * connection to itself to update parameters that are used directly within a
   * model.
   */
  std::set<shared_ptr<ModelPar> > connections;

public:
  ModelPar();
  ModelPar(std::string name_, double value_, bool fixed_ = false);

  const std::string& getName() const;

  void setLocked(bool locked_);

  bool isParameterFixed() const;
  void setParameterFixed(bool fixed_);

  void setParameterBounds(double lower_bound_, double upper_bound_);

  /**
   * Sets the value of this model parameter. Note that only by using this function
   * the set flag will be switched to true, which is a requirement for the fit.
   * Hence this method has to be used by the model parametrizations.
   */
  void setValue(double value_);
  const double& getValue() const;

  bool isSet() const;
  bool isConnected() const;
  bool isSuperior() const;

  void setSuperior(bool superior_);

  /**
   * This function adds a dependence of this model parameter on the specified
   * parameter. Once the dependent parameter changed this model parameter will
   * be updated via the specified parametrization in the corresponding handler
   * instance.
   */
  void setConnectionTo(const shared_ptr<ModelPar> &model_par);

  std::set<shared_ptr<ModelPar> >& getParameterConnections();

};

#endif /* MODELPAR_H_ */