OpenMS  3.0.0
ParamCTDFile.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: Ruben Grünberg $
32 // $Authors: Ruben Grünberg $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 #include <string>
39 
40 namespace OpenMS
41 {
42 
46  struct ToolInfo
47  {
48  std::string version_;
49  std::string name_;
50  std::string docurl_;
51  std::string category_;
52  std::string description_;
53  std::vector<std::string> citations_;
54  };
55 
61  class OPENMS_DLLAPI ParamCTDFile
62  {
63  public:
64  ParamCTDFile() = default;
65 
66  ~ParamCTDFile() = default;
67 
77  void store(const std::string& filename, const Param& param, const ToolInfo& tool_info) const;
78 
86  void writeCTDToStream(std::ostream* os_ptr, const Param& param, const ToolInfo& tool_info) const;
87 
88  private:
97  static std::string escapeXML(const std::string& to_escape);
98 
106  static void replace(std::string& replace_in, char to_replace, const std::string& replace_with);
107 
108  const std::string schema_location_ = "/SCHEMAS/Param_1_7_0.xsd";
109  const std::string schema_version_ = "1.7.0";
110  };
111 }
OpenMS::ToolInfo::description_
std::string description_
Definition: ParamCTDFile.h:52
OpenMS::ToolInfo::version_
std::string version_
Definition: ParamCTDFile.h:48
OpenMS::ParamCTDFile
Serializes a Param class in paramCTD file format. Note: only storing is currently possible.
Definition: ParamCTDFile.h:61
OpenMS::ToolInfo::category_
std::string category_
Definition: ParamCTDFile.h:51
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::ToolInfo::docurl_
std::string docurl_
Definition: ParamCTDFile.h:50
OpenMS::ToolInfo
A struct to pass information about the tool as one parameter.
Definition: ParamCTDFile.h:46
Param.h
OpenMS::ToolInfo::name_
std::string name_
Definition: ParamCTDFile.h:49
OpenMS::Param
Management and storage of parameters / INI files.
Definition: Param.h:69
OpenMS::ToolInfo::citations_
std::vector< std::string > citations_
Definition: ParamCTDFile.h:53