ParameterExceptions.h

Go to the documentation of this file.

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

#ifndef BPP_NUMERIC_PARAMETEREXCEPTIONS_H
#define BPP_NUMERIC_PARAMETEREXCEPTIONS_H


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

// From the STL:
#include <string>

namespace bpp
{
class Parameter;

class ParameterException :
  public Exception
{
private:
  const Parameter* parameter_;

public:
  // Class constructors and destructor:
  ParameterException(const std::string& text, const Parameter* param);

  ParameterException(const ParameterException& pe) :
    Exception(pe),
    parameter_(pe.parameter_) {} // We explicitely do not want to make a hard copy of the pointer here.

  ParameterException& operator=(const ParameterException& pe)
  {
    Exception::operator=(pe);
    parameter_ = pe.parameter_;
    return *this;
  }

  virtual ~ParameterException() {}

public:
  virtual const Parameter* parameter() const;
};

class ConstraintException : public ParameterException
{
private:
  double badValue_;

public:
  // Class constructor and destructor:
  ConstraintException(const std::string& text, const Parameter* param, double badValue);

  virtual ~ConstraintException() {}

public:
  virtual double getBadValue() const;
};

/*******************************************************************************/

class ParameterNotFoundException : public Exception
{
private:
  const std::string parameter_;

public:
  // Class constructors and destructor:
  ParameterNotFoundException(const std::string& text, const std::string& param = "");

  virtual ~ParameterNotFoundException() {}

public:
  virtual std::string parameter() const;
};
} // end of namespace bpp.
#endif // BPP_NUMERIC_PARAMETEREXCEPTIONS_H