bpp-core  2.1.0
 All Classes Namespaces Files Functions Variables Typedefs Friends
AutoParameter.h
Go to the documentation of this file.
1 //
2 // File: AutoParameter.h
3 // Created by: Julien Dutheil
4 // Created on: Tue Nov 11 22:15:16 2003
5 //
6 
7 /*
8 Copyright or © or Copr. Bio++ Development Team, (November 19, 2004)
9 
10 This software is a computer program whose purpose is to provide classes
11 for numerical calculus.
12 
13 This software is governed by the CeCILL license under French law and
14 abiding by the rules of distribution of free software. You can use,
15 modify and/ or redistribute the software under the terms of the CeCILL
16 license as circulated by CEA, CNRS and INRIA at the following URL
17 "http://www.cecill.info".
18 
19 As a counterpart to the access to the source code and rights to copy,
20 modify and redistribute granted by the license, users are provided only
21 with a limited warranty and the software's author, the holder of the
22 economic rights, and the successive licensors have only limited
23 liability.
24 
25 In this respect, the user's attention is drawn to the risks associated
26 with loading, using, modifying and/or developing or reproducing the
27 software by the user in light of its specific status of free software,
28 that may mean that it is complicated to manipulate, and that also
29 therefore means that it is reserved for developers and experienced
30 professionals having in-depth computer knowledge. Users are therefore
31 encouraged to load and test the software's suitability as regards their
32 requirements in conditions enabling the security of their systems and/or
33 data to be ensured and, more generally, to use and operate it in the
34 same conditions as regards security.
35 
36 The fact that you are presently reading this means that you have had
37 knowledge of the CeCILL license and that you accept its terms.
38 */
39 
40 #ifndef _AUTOPARAMETER_H_
41 #define _AUTOPARAMETER_H_
42 
43 #include "Parameter.h"
44 
45 //From Utils:
46 #include "../Io/OutputStream.h"
47 
48 namespace bpp
49 {
50 
58 class AutoParameter:
59  public Parameter
60 {
61  private:
62  OutputStream* messageHandler_;
63 
64  public:
65 
76  AutoParameter(const std::string& name = "", double value = 0, Constraint* constraint = 0, bool attachConstraint = false) throw (ConstraintException);
77 
83  AutoParameter(const Parameter& param);
84 
90  AutoParameter(const AutoParameter& param);
91 
97  AutoParameter& operator=(const AutoParameter& param);
98 
99  virtual ~AutoParameter() {}
100 
101  AutoParameter* clone() const { return new AutoParameter(* this); }
102 
103  public:
104 
119  virtual void setValue(double value) throw (ConstraintException);
120 
121  public: //Specific method:
122 
134  virtual void setMessageHandler(OutputStream* mh) { messageHandler_ = mh; }
135 
136  public:
137 
138  static std::string CONSTRAINTS_AUTO;
139  static std::string CONSTRAINTS_IGNORE;
140  static std::string CONSTRAINTS_KEEP;
141 };
142 
143 } //end of namespace bpp.
144 
145 #endif //_AUTOPARAMETER_H_
146