OpenMS  3.0.0
ParamXMLHandler.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-2022.
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, Stephan Aiche $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
39 
40 #include <vector>
41 #include <map>
42 
43 namespace OpenMS
44 {
45  namespace Internal
46  {
51  class OPENMS_DLLAPI ParamXMLHandler :
52  public XMLHandler
53  {
54 public:
56  ParamXMLHandler(Param& param, const String& filename, const String& version);
58  ~ParamXMLHandler() override;
59 
60  // Docu in base class
61  void endElement(const XMLCh* const uri, const XMLCh* const local_name, const XMLCh* const qname) override;
62 
63  // Docu in base class
64  void startElement(const XMLCh* const uri, const XMLCh* const local_name, const XMLCh* const qname, const xercesc::Attributes& attributes) override;
65 
66 protected:
72  std::map<String, String> descriptions_;
73 
75  struct
76  {
77  String name;
78  String type;
79  std::vector<std::string> stringlist;
80  IntList intlist;
81  DoubleList doublelist;
82  std::vector<std::string> tags;
83  String description;
84  String restrictions;
85  Int restrictions_index;
86  } list_;
87 
88 private:
91  };
92 
93  } // namespace Internal
94 } // namespace OpenMS
95 
OpenMS::Internal::ParamXMLHandler::param_
Param & param_
Reference to the Param object to fill.
Definition: ParamXMLHandler.h:70
OpenMS::Internal::XMLHandler
Base class for XML handlers.
Definition: XMLHandler.h:323
OpenMS::Internal::ParamXMLHandler::descriptions_
std::map< String, String > descriptions_
Map of node descriptions (they are set at the end of parsing)
Definition: ParamXMLHandler.h:72
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::DoubleList
std::vector< double > DoubleList
Vector of double precision real types.
Definition: ListUtils.h:62
XMLHandler.h
OpenMS::IntList
std::vector< Int > IntList
Vector of signed integers.
Definition: ListUtils.h:55
OpenMS::Internal::ParamXMLHandler::path_
String path_
The current absolute path (concatenation of nodes_ with : in between)
Definition: ParamXMLHandler.h:68
OpenMS::Int
int Int
Signed integer type.
Definition: Types.h:102
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
Param.h
OpenMS::Param
Management and storage of parameters / INI files.
Definition: Param.h:69
OpenMS::Internal::ParamXMLHandler
XML Handler for Param files.
Definition: ParamXMLHandler.h:51