TVToolDiscovery.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: David Voigt $
// $Authors: David Voigt $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
 
#include <future>
#include <map>
#include <OpenMS/DATASTRUCTURES/Param.h>
#include <OpenMS/DATASTRUCTURES/ListUtils.h>
 
namespace OpenMS
{
  class OPENMS_GUI_DLLAPI TVToolDiscovery
  {
  public:
    TVToolDiscovery() :
      plugin_path_() {};
 
    TVToolDiscovery(const TVToolDiscovery&) = delete;
 
    TVToolDiscovery& operator=(const TVToolDiscovery&) = delete;
 
    ~TVToolDiscovery() = default;
 
    void loadToolParams();
 
    void waitForToolParams();
    void waitForPluginParams();
 
    const Param& getToolParams();
 
    const Param& getPluginParams();
 
    const std::vector<std::string>& getPlugins();
 
    [[maybe_unused]] bool setPluginPath(const std::string& path, bool create=false);
 
    void setVerbose(int verbosity_level);
 
    const std::string getPluginPath();
 
    std::string findPluginExecutable(const std::string& name);
 
  private:
    static Param getParamFromIni_(const std::string& tool_path, bool plugins=false);
 
    void loadPluginParams();
 
    const StringList getPlugins_();
 
    std::string plugin_path_;
 
    std::vector<std::future<Param>> tool_param_futures_;
    std::vector<std::future<Param>> plugin_param_futures_;
 
    Param tool_params_;
 
    Param plugin_params_;
 
    std::vector<std::string> plugins_;
 
    int verbosity_level_ = 0;
  };
}