bpp-core3  3.0.0
AutoParameter.h
Go to the documentation of this file.
1 //
2 // File: AutoParameter.h
3 // Authors:
4 // Julien Dutheil
5 // Created: 2003-11-11 22:15:16
6 //
7 
8 /*
9  Copyright or © or Copr. Bio++ Development Team, (November 19, 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_AUTOPARAMETER_H
42 #define BPP_NUMERIC_AUTOPARAMETER_H
43 
44 
45 #include "Parameter.h"
46 
47 // From Utils:
48 #include "../Io/OutputStream.h"
49 
50 namespace bpp
51 {
60  public Parameter
61 {
62 private:
64 
65 public:
74  AutoParameter(const std::string& name = "", double value = 0, std::shared_ptr<Constraint> constraint = 0);
75 
81  AutoParameter(const Parameter& param);
82 
88  AutoParameter(const AutoParameter& param);
89 
95  AutoParameter& operator=(const AutoParameter& param);
96 
97  virtual ~AutoParameter() {}
98 
99  AutoParameter* clone() const { return new AutoParameter(*this); }
100 
101 public:
115  virtual void setValue(double value);
116 
117 public:
118  // Specific method:
119 
131  virtual void setMessageHandler(OutputStream* mh) { messageHandler_ = mh; }
132 
133 public:
134  static std::string CONSTRAINTS_AUTO;
135  static std::string CONSTRAINTS_IGNORE;
136  static std::string CONSTRAINTS_KEEP;
137 };
138 } // end of namespace bpp.
139 #endif // BPP_NUMERIC_AUTOPARAMETER_H
The AutoParameter class.
Definition: AutoParameter.h:61
AutoParameter(const std::string &name="", double value=0, std::shared_ptr< Constraint > constraint=0)
Build a new AutoParameter.
virtual void setValue(double value)
Set the value of this parameter.
static std::string CONSTRAINTS_AUTO
AutoParameter & operator=(const AutoParameter &param)
Assignment operator.
static std::string CONSTRAINTS_IGNORE
virtual void setMessageHandler(OutputStream *mh)
Set the message handler for this AutoParameter.
OutputStream * messageHandler_
Definition: AutoParameter.h:63
AutoParameter * clone() const
Create a copy of this object and send a pointer to it.
Definition: AutoParameter.h:99
virtual ~AutoParameter()
Definition: AutoParameter.h:97
static std::string CONSTRAINTS_KEEP
OutputStream interface.
Definition: OutputStream.h:67
This class is designed to facilitate the manipulation of parameters.
Definition: Parameter.h:135