Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
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-2017.
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 #ifndef OPENMS_FORMAT_HANDLERS_PARAMXMLHANDLER_H
36 #define OPENMS_FORMAT_HANDLERS_PARAMXMLHANDLER_H
37 
40 
41 #include <vector>
42 #include <map>
43 
44 namespace OpenMS
45 {
46  namespace Internal
47  {
52  class OPENMS_DLLAPI ParamXMLHandler :
53  public XMLHandler
54  {
55 public:
57  ParamXMLHandler(Param& param, const String& filename, const String& version);
59  virtual ~ParamXMLHandler();
60 
61  // Docu in base class
62  virtual void endElement(const XMLCh* const uri, const XMLCh* const local_name, const XMLCh* const qname);
63 
64  // Docu in base class
65  virtual void startElement(const XMLCh* const uri, const XMLCh* const local_name, const XMLCh* const qname, const xercesc::Attributes& attributes);
66 
67 protected:
73  std::map<String, String> descriptions_;
74 
76  struct
77  {
87  } list_;
88 
89 private:
92  };
93 
94  } // namespace Internal
95 } // namespace OpenMS
96 
97 #endif // OPENMS_FORMAT_HANDLERS_PARAMXMLHANDLER_H
String restrictions
Definition: ParamXMLHandler.h:85
A more convenient string class.
Definition: String.h:57
DoubleList doublelist
Definition: ParamXMLHandler.h:82
IntList intlist
Definition: ParamXMLHandler.h:81
std::vector< double > DoubleList
Vector of double precision real types.
Definition: ListUtils.h:66
String name
Definition: ParamXMLHandler.h:78
std::vector< Int > IntList
Vector of signed integers.
Definition: ListUtils.h:59
Base class for XML handlers.
Definition: XMLHandler.h:110
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
StringList stringlist
Definition: ParamXMLHandler.h:80
StringList tags
Definition: ParamXMLHandler.h:83
Int restrictions_index
Definition: ParamXMLHandler.h:86
String description
Definition: ParamXMLHandler.h:84
XML Handler for Param files.
Definition: ParamXMLHandler.h:52
String type
Definition: ParamXMLHandler.h:79
std::vector< String > StringList
Vector of String.
Definition: ListUtils.h:74
Management and storage of parameters / INI files.
Definition: Param.h:75
std::map< String, String > descriptions_
Map of node descriptions (they are set at the end of parsing)
Definition: ParamXMLHandler.h:73
String path_
The current absolute path (concatenation of nodes_ with : in between)
Definition: ParamXMLHandler.h:69
int Int
Signed integer type.
Definition: Types.h:103
Param & param_
Reference to the Param object to fill.
Definition: ParamXMLHandler.h:71

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:22:02 using doxygen 1.8.13