OpenMS
ToolDescriptionHandler.h
Go to the documentation of this file.
1 // Copyright (c) 2002-present, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
2 // SPDX-License-Identifier: BSD-3-Clause
3 //
4 // --------------------------------------------------------------------------
5 // $Maintainer: Chris Bielow $
6 // $Authors: Chris Bielow $
7 // --------------------------------------------------------------------------
8 
9 #pragma once
10 
15 
16 namespace OpenMS
17 {
18  class ProgressLogger;
19 
20  namespace Internal
21  {
22 
28  class OPENMS_DLLAPI ToolDescriptionHandler :
29  public ParamXMLHandler
30  {
31 public:
34 
36  ToolDescriptionHandler(const String & filename, const String & version);
37 
41 
42 
43  // Docu in base class
44  void endElement(const XMLCh * const /*uri*/, const XMLCh * const /*local_name*/, const XMLCh * const qname) override;
45 
46  // Docu in base class
47  void startElement(const XMLCh * const /*uri*/, const XMLCh * const /*local_name*/, const XMLCh * const qname, const xercesc::Attributes & attributes) override;
48 
49  // Docu in base class
50  void characters(const XMLCh * const chars, const XMLSize_t length) override;
51 
52  // NOT IMPLEMENTED
53  void writeTo(std::ostream & os) override;
54 
55  // Retrieve parsed tool description
56  const std::vector<ToolDescription> & getToolDescriptions() const;
57 
58  // Set tool description for writing
59  void setToolDescriptions(const std::vector<ToolDescription> & td);
60 
61 protected:
62 
64 
67  std::vector<Internal::ToolDescription> td_vec_;
68 
70 
72 
73 private:
74 
78 
79  };
80  } // namespace Internal
81 } // namespace OpenMS
82 
XML Handler for Param files.
Definition: ParamXMLHandler.h:27
XML handler for ToolDescriptionFile.
Definition: ToolDescriptionHandler.h:30
ToolDescriptionHandler(const String &filename, const String &version)
Constructor.
void writeTo(std::ostream &os) override
Writes the contents to a stream.
String tag_
Definition: ToolDescriptionHandler.h:69
ToolDescriptionHandler & operator=(const ToolDescriptionHandler &rhs)
std::vector< Internal::ToolDescription > td_vec_
Definition: ToolDescriptionHandler.h:67
Param p_
Definition: ToolDescriptionHandler.h:63
bool in_ini_section_
Definition: ToolDescriptionHandler.h:71
void startElement(const XMLCh *const, const XMLCh *const, const XMLCh *const qname, const xercesc::Attributes &attributes) override
ToolDescriptionHandler(const ToolDescriptionHandler &rhs)
const std::vector< ToolDescription > & getToolDescriptions() const
void characters(const XMLCh *const chars, const XMLSize_t length) override
Internal::ToolExternalDetails tde_
Definition: ToolDescriptionHandler.h:65
void endElement(const XMLCh *const, const XMLCh *const, const XMLCh *const qname) override
void setToolDescriptions(const std::vector< ToolDescription > &td)
Internal::ToolDescription td_
Definition: ToolDescriptionHandler.h:66
~ToolDescriptionHandler() override
Destructor.
Management and storage of parameters / INI files.
Definition: Param.h:44
A more convenient string class.
Definition: String.h:34
Definition: ToolDescription.h:95
Main OpenMS namespace.
Definition: openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19
Definition: ToolDescription.h:112