OpenMS  2.8.0
TVToolDiscovery.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-2021.
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: David Voigt $
32 // $Authors: David Voigt $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 #include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
38 
39 #include <future>
40 #include <map>
42 
43 namespace OpenMS
44 {
61  class OPENMS_GUI_DLLAPI TVToolDiscovery
62  {
63  public:
65 
66  TVToolDiscovery(const TVToolDiscovery &) = delete;
67 
69 
71 
73  void loadParams();
74 
80  void waitForParams();
81 
89  const std::map<std::string, Param> &getToolParams();
90 
91  private:
93  static Param getParamFromIni_(const std::string &tool_name);
94 
96  std::map<std::string, std::future<Param>> param_futures_;
97 
99  std::map<std::string, Param> params_;
100  };
101 }
const char * tool_name
Definition: SwathWizard.cpp:146
Management and storage of parameters / INI files.
Definition: Param.h:70
Scans for tools/utils and generates a param for each asynchronously.
Definition: TVToolDiscovery.h:62
std::map< std::string, std::future< Param > > param_futures_
Contains a param future for each tool/util name.
Definition: TVToolDiscovery.h:96
const std::map< std::string, Param > & getToolParams()
Returns a hash map containing a param for each tool/util.
void loadParams()
Start creating params for each tool/util asynchronously.
TVToolDiscovery & operator=(const TVToolDiscovery &)=delete
TVToolDiscovery()
Definition: TVToolDiscovery.h:64
TVToolDiscovery(const TVToolDiscovery &)=delete
~TVToolDiscovery()
Definition: TVToolDiscovery.h:70
std::map< std::string, Param > params_
Contains a mapping of each tool/util name to its param.
Definition: TVToolDiscovery.h:99
void waitForParams()
Wait for all future params to finish evaluating.
static Param getParamFromIni_(const std::string &tool_name)
Returns param for a given tool/util. This function is thread-safe.
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47