OpenMS
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-2023.
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 
39 #include <OpenMS/OpenMSConfig.h>
40 #include <vector>
41 
42 namespace OpenMS
43 {
44  class MetaInfoInterface;
91  class OPENMS_DLLAPI DefaultParamHandler
92  {
93  public:
96 
99 
102 
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 
145  static void writeParametersToMetaValues(const Param& write_this, MetaInfoInterface& write_here, const String& key_prefix = "");
146 
147  protected:
155  virtual void updateMembers_();
156 
163 
166 
173 
179  std::vector<String> subsections_;
180 
183 
192 
200 
201  private:
204 
205  }; // class
206 
207 } // namespace OpenMS
A base class for all classes handling default parameters.
Definition: DefaultParamHandler.h:92
virtual ~DefaultParamHandler()
Destructor.
virtual bool operator==(const DefaultParamHandler &rhs) const
Equality operator.
const Param & getParameters() const
Non-mutable access to the parameters.
void defaultsToParam_()
Updates the parameters after the defaults have been set in the constructor.
Param param_
Container for current parameters.
Definition: DefaultParamHandler.h:165
const std::vector< String > & getSubsections() const
Non-mutable access to the registered subsections.
String error_name_
Name that is displayed in error messages during the parameter checking.
Definition: DefaultParamHandler.h:182
DefaultParamHandler & operator=(const DefaultParamHandler &rhs)
Assignment operator.
Param defaults_
Container for default parameters. This member should be filled in the constructor of derived classes!
Definition: DefaultParamHandler.h:172
virtual void updateMembers_()
This method is used to update extra member variables at the end of the setParameters() method.
void setName(const String &name)
Mutable access to the name.
DefaultParamHandler()
Hidden default C'tor (class name parameter is required!)
bool check_defaults_
If this member is set to false no checking if parameters in done;.
Definition: DefaultParamHandler.h:191
static void writeParametersToMetaValues(const Param &write_this, MetaInfoInterface &write_here, const String &key_prefix="")
Writes all parameters to meta values.
DefaultParamHandler(const DefaultParamHandler &rhs)
Copy constructor.
const String & getName() const
Non-mutable access to the name.
bool warn_empty_defaults_
If this member is set to false no warning is emitted when defaults are empty;.
Definition: DefaultParamHandler.h:199
void setParameters(const Param &param)
Sets the parameters.
std::vector< String > subsections_
Container for registered subsections. This member should be filled in the constructor of derived clas...
Definition: DefaultParamHandler.h:179
const Param & getDefaults() const
Non-mutable access to the default parameters.
DefaultParamHandler(const String &name)
Constructor with name that is displayed in error messages.
Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).
Definition: MetaInfoInterface.h:61
Management and storage of parameters / INI files.
Definition: Param.h:70
A more convenient string class.
Definition: String.h:60
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48