OpenMS  3.0.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-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: Chris Bielow $
32 // $Authors: Chris Bielow $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
40 
41 #include <map>
42 
43 namespace OpenMS
44 {
49  typedef std::map<Internal::ToolDescriptionInternal, Internal::ToolDescriptionInternal> ToolMapping;
51 
52  class OPENMS_DLLAPI INIUpdater
53  {
54 public:
55 
56  INIUpdater();
57 
58 
59  StringList getToolNamesFromINI(const Param & ini) const;
60 
61  const ToolMapping & getNameMapping();
62 
63  /*
64  Finds the name of the new tool.
65  The tools_type is optional and should be "" if there is none.
66 
67  The tools_type is ignored if there is a mapping without a type.
68 
69  @return true on success
70  */
71  bool getNewToolName(const String & old_name, const String & tools_type, String & new_name);
72 
73 private:
74  static ToolMapping map_;
75 
76  };
77 
78 } // namespace OpenMS
79 
OpenMS::INIUpdater
Definition: INIUpdater.h:52
ToolDescription.h
OpenMS::TOPPBase
Base class for TOPP applications.
Definition: TOPPBase.h:147
FileHandler.h
Size
OpenMS::INIUpdater::map_
static ToolMapping map_
Definition: INIUpdater.h:74
OpenMS::Param::setValue
void setValue(const std::string &key, const ParamValue &value, const std::string &description="", const std::vector< std::string > &tags=std::vector< std::string >())
Sets a value.
OpenMS::Param::insert
void insert(const std::string &prefix, const Param &param)
OpenMS::StringUtils::toQString
static QString toQString(const String &this_s)
Definition: StringUtils.h:201
TOPPASScene.h
OpenMS::TOPPASScene
A container for all visual items of a TOPPAS workflow.
Definition: TOPPASScene.h:85
OpenMS::FileTypes::TOPPAS
OpenMS parameters file with workflow information (.toppas)
Definition: FileTypes.h:68
OpenMS::String
A more convenient string class.
Definition: String.h:58
ParamXMLFile.h
Int
OpenMS::FileTypes::INI
OpenMS parameters file (.ini)
Definition: FileTypes.h:67
OpenMS::Constants::c
const double c
Definition: Constants.h:209
OpenMS::ParamXMLFile
The file pendant of the Param class used to load and store the param datastructure as paramXML.
Definition: ParamXMLFile.h:49
OpenMS::File::remove
static bool remove(const String &file)
Removes a file (if it exists).
OpenMS::File::getUniqueName
static String getUniqueName(bool include_hostname=true)
Returns a string, consisting of date, time, hostname, process id, and a incrementing number....
OpenMS::File::getExecutablePath
static String getExecutablePath()
OpenMS::INIUpdater::getToolNamesFromINI
StringList getToolNamesFromINI(const Param &ini) const
OpenMS::ListUtils::concatenate
static String concatenate(const std::vector< T > &container, const String &glue="")
Concatenates all elements of the container and puts the glue string between elements.
Definition: ListUtils.h:209
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::FileHandler
Facilitates file handling by file type recognition.
Definition: FileHandler.h:66
QProcess
OpenMS::FileTypes::Type
Type
Actual file types enum.
Definition: FileTypes.h:56
OpenMS::INIUpdater::getNewToolName
bool getNewToolName(const String &old_name, const String &tools_type, String &new_name)
Param.h
OpenMS::FileHandler::getType
static FileTypes::Type getType(const String &filename)
Tries to determine the file type (by name or content)
OpenMS::Param::exists
bool exists(const std::string &key) const
Tests if a parameter is set (expecting its fully qualified name, e.g., TextExporter:1:proteins_only)
OpenMS::String::toQString
QString toQString() const
Conversion to Qt QString.
INIUpdater.h
OpenMS::StringList
std::vector< String > StringList
Vector of String.
Definition: ListUtils.h:70
OpenMS::ParamValue::toString
std::string toString(bool full_precision=true) const
Convert ParamValue to string.
main
int main(int argc, const char **argv)
Definition: INIFileEditor.cpp:71
OpenMS::Param::update
bool update(const Param &p_outdated, const bool add_unknown=false)
Rescue parameter values from p_outdated to current param.
OpenMS::Param::copy
Param copy(const std::string &prefix, bool remove_prefix=false) const
Returns a new Param object containing all entries that start with prefix.
String.h
OpenMS::Param
Management and storage of parameters / INI files.
Definition: Param.h:69
OpenMS::File::getTempDirectory
static String getTempDirectory()
OpenMS::ParamXMLFile::store
void store(const String &filename, const Param &param) const
Write XML file.
OpenMS::ToolMapping
std::map< Internal::ToolDescriptionInternal, Internal::ToolDescriptionInternal > ToolMapping
Updates an INI.
Definition: INIUpdater.h:50
OpenMS::ParamXMLFile::load
void load(const String &filename, Param &param)
Read XML file.
OpenMS::Param::getValue
const ParamValue & getValue(const std::string &key) const
Returns a value of a parameter.
QApplication
OpenMS::Param::remove
void remove(const std::string &key)
Remove the entry key or a section key (when suffix is ':')
File.h
OpenMS::Internal::ClassTest::infile
std::ifstream infile
Questionable file tested by TEST_FILE_EQUAL.
TOPPBase.h