bpp-core3  3.0.0
ParameterExceptions.h
Go to the documentation of this file.
1 //
2 // File: ParameterExceptions.h
3 // Authors:
4 // Julien Dutheil
5 // Created: 2003-11-03 18:05:36
6 //
7 
8 /*
9  Copyright or © or Copr. Bio++ Development Team, (November 17, 2004)
10 
11  This software is a computer program whose purpose is to provide classes
12  for numerical calculus.
13 
14  This software is governed by the CeCILL license under French law and
15  abiding by the rules of distribution of free software. You can use,
16  modify and/ or redistribute the software under the terms of the CeCILL
17  license as circulated by CEA, CNRS and INRIA at the following URL
18  "http://www.cecill.info".
19 
20  As a counterpart to the access to the source code and rights to copy,
21  modify and redistribute granted by the license, users are provided only
22  with a limited warranty and the software's author, the holder of the
23  economic rights, and the successive licensors have only limited
24  liability.
25 
26  In this respect, the user's attention is drawn to the risks associated
27  with loading, using, modifying and/or developing or reproducing the
28  software by the user in light of its specific status of free software,
29  that may mean that it is complicated to manipulate, and that also
30  therefore means that it is reserved for developers and experienced
31  professionals having in-depth computer knowledge. Users are therefore
32  encouraged to load and test the software's suitability as regards their
33  requirements in conditions enabling the security of their systems and/or
34  data to be ensured and, more generally, to use and operate it in the
35  same conditions as regards security.
36 
37  The fact that you are presently reading this means that you have had
38  knowledge of the CeCILL license and that you accept its terms.
39 */
40 
41 #ifndef BPP_NUMERIC_PARAMETEREXCEPTIONS_H
42 #define BPP_NUMERIC_PARAMETEREXCEPTIONS_H
43 
44 
45 
46 // From Utils:
47 #include "../Exceptions.h"
48 
49 // From the STL:
50 #include <string>
51 
52 namespace bpp
53 {
54 class Parameter;
55 
62  public Exception
63 {
64 private:
66 
67 public:
68  // Class constructors and destructor:
75  ParameterException(const std::string& text, const Parameter* param);
76 
78  Exception(pe),
79  parameter_(pe.parameter_) {} // We explicitely do not want to make a hard copy of the pointer here.
80 
82  {
83  Exception::operator=(pe);
85  return *this;
86  }
87 
88  virtual ~ParameterException() {}
89 
90 public:
96  virtual const Parameter* getParameter() const;
97 };
98 
105 {
106 private:
107  double badValue_;
108 
109 public:
110  // Class constructor and destructor:
118  ConstraintException(const std::string& text, const Parameter* param, double badValue);
119 
120  virtual ~ConstraintException() {}
121 
122 public:
128  virtual double getBadValue() const;
129 };
130 
131 /*******************************************************************************/
132 
138 {
139 private:
140  const std::string parameter_;
141 
142 public:
143  // Class constructors and destructor:
150  ParameterNotFoundException(const std::string& text, const std::string& param = "");
151 
153 
154 public:
160  virtual std::string getParameter() const;
161 };
162 } // end of namespace bpp.
163 #endif // BPP_NUMERIC_PARAMETEREXCEPTIONS_H
Exception thrown when a value do not match a given constraint.
ConstraintException(const std::string &text, const Parameter *param, double badValue)
Build a new ConstraintException object.
virtual double getBadValue() const
Get the value that doesn't match the constraint.
Exception base class. Overload exception constructor (to control the exceptions mechanism)....
Definition: Exceptions.h:59
The parameter exception base class.
ParameterException(const std::string &text, const Parameter *param)
Build a new ParameterException object.
virtual const Parameter * getParameter() const
Get the parameter that threw the exception.
ParameterException(const ParameterException &pe)
ParameterException & operator=(const ParameterException &pe)
const Parameter * parameter_
Exception thrown when a parameter is not found, for instance in a ParameterList.
virtual std::string getParameter() const
Get the name of the parameter not found.
ParameterNotFoundException(const std::string &text, const std::string &param="")
Build a new ParameterNotFoundException object.
This class is designed to facilitate the manipulation of parameters.
Definition: Parameter.h:135