| OpenMS 2.5.0

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-2020.
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: Timo Sachsenberg$
32 // $Authors: Marc Sturm $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/DATASTRUCTURES/Param.h>
38 #include <OpenMS/DATASTRUCTURES/String.h>
39 #include <OpenMS/OpenMSConfig.h>
40
41 #include <vector>
42
43 namespace OpenMS
44 {
91 class OPENMS_DLLAPI DefaultParamHandler
92 {
93 public:
95 DefaultParamHandler(const String& name);
96
98 DefaultParamHandler(const DefaultParamHandler& rhs);
99
101 virtual ~DefaultParamHandler();
102
104 virtual DefaultParamHandler& operator=(const DefaultParamHandler& rhs);
105
107 virtual bool operator==(const DefaultParamHandler& rhs) const;
108
118 void setParameters(const Param& param);
119
121 const Param& getParameters() const;
122
124 const Param& getDefaults() const;
125
127 const String& getName() const;
128
130 void setName(const String& name);
131
133 const std::vector<String>& getSubsections() const;
134
135 protected:
143 virtual void updateMembers_();
144
146 void defaultsToParam_();
147
149 Param param_;
150
156 Param defaults_;
157
163 std::vector<String> subsections_;
164
166 String error_name_;
167
175 bool check_defaults_;
176
183 bool warn_empty_defaults_;
184
185 private:
187 DefaultParamHandler();
188
189 }; //class
190
191 } // namespace OPENMS
192
OpenMS::DefaultParamHandler::check_defaults_
bool check_defaults_
If this member is set to false no checking if parameters in done;.
Definition: DefaultParamHandler.h:175
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::DefaultParamHandler::defaults_
Param defaults_
Container for default parameters. This member should be filled in the constructor of derived classes!...
Definition: DefaultParamHandler.h:156
OpenMS::DefaultParamHandler
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:91
OpenMS::DefaultParamHandler::error_name_
String error_name_
Name that is displayed in error messages during the parameter checking.
Definition: DefaultParamHandler.h:166
OpenMS::DefaultParamHandler::subsections_
std::vector< String > subsections_
Container for registered subsections. This member should be filled in the constructor of derived clas...
Definition: DefaultParamHandler.h:163
String.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
Param.h
OpenMS::Param
Management and storage of parameters / INI files.
Definition: Param.h:73
OpenMS::DefaultParamHandler::param_
Param param_
Container for current parameters.
Definition: DefaultParamHandler.h:149
KDTree::operator==
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806
OpenMS::DefaultParamHandler::warn_empty_defaults_
bool warn_empty_defaults_
If this member is set to false no warning is emitted when defaults are empty;.
Definition: DefaultParamHandler.h:183