| OpenMS 2.5.0

ToolDescriptionHandler.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: Chris Bielow $
32 // $Authors: Chris Bielow $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 #include <OpenMS/FORMAT/HANDLERS/XMLHandler.h>
38 #include <OpenMS/FORMAT/ControlledVocabulary.h>
39 #include <OpenMS/DATASTRUCTURES/ToolDescription.h>
40 #include <OpenMS/FORMAT/HANDLERS/ParamXMLHandler.h>
41
42 namespace OpenMS
43 {
44 class ProgressLogger;
45
46 namespace Internal
47 {
48
54 class OPENMS_DLLAPI ToolDescriptionHandler :
55 public ParamXMLHandler
56 {
57 public:
60
62 ToolDescriptionHandler(const String & filename, const String & version);
63
65 ~ToolDescriptionHandler() override;
67
68
69 // Docu in base class
70 void endElement(const XMLCh * const /*uri*/, const XMLCh * const /*local_name*/, const XMLCh * const qname) override;
71
72 // Docu in base class
73 void startElement(const XMLCh * const /*uri*/, const XMLCh * const /*local_name*/, const XMLCh * const qname, const xercesc::Attributes & attributes) override;
74
75 // Docu in base class
76 void characters(const XMLCh * const chars, const XMLSize_t length) override;
77
78 // NOT IMPLEMENTED
79 void writeTo(std::ostream & os) override;
80
81 // Retrieve parsed tool description
82 const std::vector<ToolDescription> & getToolDescriptions() const;
83
84 // Set tool description for writing
85 void setToolDescriptions(const std::vector<ToolDescription> & td);
86
87 protected:
88
89 Param p_;
90
91 Internal::ToolExternalDetails tde_;
92 Internal::ToolDescription td_;
93 std::vector<Internal::ToolDescription> td_vec_;
94
95 String tag_;
96
97 bool in_ini_section_;
98
99 private:
100
101 ToolDescriptionHandler();
102 ToolDescriptionHandler(const ToolDescriptionHandler & rhs);
103 ToolDescriptionHandler & operator=(const ToolDescriptionHandler & rhs);
104
105 };
106 } // namespace Internal
107 } // namespace OpenMS
108
OpenMS::Internal::ToolExternalDetails
Definition: ToolDescription.h:106
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::Internal::ToolDescriptionHandler::td_vec_
std::vector< Internal::ToolDescription > td_vec_
Definition: ToolDescriptionHandler.h:93
XMLHandler.h
OpenMS::Internal::ToolDescriptionHandler::td_
Internal::ToolDescription td_
Definition: ToolDescriptionHandler.h:92
ToolDescription.h
ControlledVocabulary.h
ParamXMLHandler.h
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::Internal::ToolDescriptionHandler::p_
Param p_
Definition: ToolDescriptionHandler.h:89
OpenMS::Internal::ToolDescription
Definition: ToolDescription.h:122
OpenMS::Internal::ToolDescriptionHandler
XML handler for ToolDescriptionFile.
Definition: ToolDescriptionHandler.h:54
OpenMS::Internal::ParamXMLHandler
XML Handler for Param files.
Definition: ParamXMLHandler.h:51
OpenMS::Param
Management and storage of parameters / INI files.
Definition: Param.h:73
OpenMS::Internal::ToolDescriptionHandler::tde_
Internal::ToolExternalDetails tde_
Definition: ToolDescriptionHandler.h:91
OpenMS::Internal::ToolDescriptionHandler::tag_
String tag_
Definition: ToolDescriptionHandler.h:95
OpenMS::Internal::ToolDescriptionHandler::in_ini_section_
bool in_ini_section_
Definition: ToolDescriptionHandler.h:97