| OpenMS 2.5.0

INIUpdater.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/DATASTRUCTURES/Map.h>
38 #include <OpenMS/DATASTRUCTURES/String.h>
39 #include <OpenMS/DATASTRUCTURES/Param.h>
40 #include <OpenMS/DATASTRUCTURES/ToolDescription.h>
41
42 namespace OpenMS
43 {
48 typedef Map<Internal::ToolDescriptionInternal, Internal::ToolDescriptionInternal> ToolMapping;
50
51 class OPENMS_DLLAPI INIUpdater
52 {
53 public:
54
55 INIUpdater();
56
57
58 StringList getToolNamesFromINI(const Param & ini) const;
59
60 const ToolMapping & getNameMapping();
61
62 /*
63 Finds the name of the new tool.
64 The tools_type is optional and should be "" if there is none.
65
66 The tools_type is ignored if there is a mapping without a type.
67
68 @return true on success
69 */
70 bool getNewToolName(const String & old_name, const String & tools_type, String & new_name);
71
72 private:
73 static ToolMapping map_;
74
75 };
76
77 } // namespace OpenMS
78
OpenMS::String
A more convenient string class.
Definition: String.h:58
ToolDescription.h
String.h
OpenMS::Map
Map class based on the STL map (containing several convenience functions)
Definition: Map.h:50
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::INIUpdater::map_
static ToolMapping map_
Definition: INIUpdater.h:73
Param.h
Map.h
OpenMS::Param
Management and storage of parameters / INI files.
Definition: Param.h:73
OpenMS::StringList
std::vector< String > StringList
Vector of String.
Definition: ListUtils.h:70
OpenMS::INIUpdater
Definition: INIUpdater.h:51
OpenMS::ToolMapping
Map< Internal::ToolDescriptionInternal, Internal::ToolDescriptionInternal > ToolMapping
Updates an INI.
Definition: INIUpdater.h:49