Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
DefaultParamHandler.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2013.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Stephan Aiche$
32 // $Authors: Marc Sturm $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_DATASTRUCTURES_DEFAULTPARAMHANDLER_H
36 #define OPENMS_DATASTRUCTURES_DEFAULTPARAMHANDLER_H
37 
39 
40 #include <vector>
41 
42 namespace OpenMS
43 {
90  class OPENMS_DLLAPI DefaultParamHandler
91  {
92 public:
94  DefaultParamHandler(const String & name);
95 
98 
100  virtual ~DefaultParamHandler();
101 
103  virtual DefaultParamHandler & operator=(const DefaultParamHandler & rhs);
104 
106  virtual bool operator==(const DefaultParamHandler & rhs) const;
107 
117  void setParameters(const Param & param);
118 
120  const Param & getParameters() const;
121 
123  const Param & getDefaults() const;
124 
126  const String & getName() const;
127 
129  void setName(const String & name);
130 
132  const std::vector<String> & getSubsections() const;
133 
134 protected:
142  virtual void updateMembers_();
143 
145  void defaultsToParam_();
146 
149 
156 
162  std::vector<String> subsections_;
163 
166 
175 
183 
184 private:
187 
188  }; //class
189 
190 } // namespace OPENMS
191 
192 #endif // OPENMS_DATASTRUCTURES_DEFAULTPARAMHANDLER_H
Param defaults_
Container for default parameters. This member should be filled in the constructor of derived classes!...
Definition: DefaultParamHandler.h:155
String error_name_
Name that is displayed in error messages during the parameter checking.
Definition: DefaultParamHandler.h:165
A more convenient string class.
Definition: String.h:56
bool warn_empty_defaults_
If this member is set to false no warning is emitted when defaults are empty;.
Definition: DefaultParamHandler.h:182
Param param_
Container for current parameters.
Definition: DefaultParamHandler.h:148
std::vector< String > subsections_
Container for registered subsections. This member should be filled in the constructor of derived clas...
Definition: DefaultParamHandler.h:162
Management and storage of parameters / INI files.
Definition: Param.h:69
bool check_defaults_
If this member is set to false no checking if parameters in done;.
Definition: DefaultParamHandler.h:174
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:90

OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:12 using doxygen 1.8.5