TOPPExternalToolBase.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: Timo Sachsenberg $
// $Authors: Marc Sturm, Clemens Groepl, Chris Bielow $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/APPLICATIONS/OpenMS_CLIConfig.h>
 
#include <OpenMS/APPLICATIONS/TOPPBase.h>
 
#include <map>
#include <string>
#include <vector>
 
namespace OpenMS
{
  class OPENMS_CLI_DLLAPI TOPPExternalToolBase : public TOPPBase
  {
  public:
    TOPPExternalToolBase() = delete;
 
    TOPPExternalToolBase(const TOPPExternalToolBase&) = delete;
 
    using TOPPBase::TOPPBase;
 
    ~TOPPExternalToolBase() override;
 
    static StringList getThirdPartyToolLocations();
 
    static StringList getThirdPartyToolLocations(const std::string& data_path);
 
    static bool findThirdPartyExecutable(std::string& exe_filename);
 
    static bool findThirdPartyExecutable(std::string& exe_filename, const StringList& locations);
 
  protected:
    bool findExecutable_(std::string& executable) const override;
 
    ExitCodes runExternalProcess_(const std::string& executable, const std::vector<std::string>& arguments, const std::string& workdir = "", const std::map<std::string, std::string>& env = {}) const;
 
    ExitCodes runExternalProcess_(const std::string& executable, const std::vector<std::string>& arguments, std::string& proc_stdout, std::string& proc_stderr, const std::string& workdir = "", const std::map<std::string, std::string>& env = {}) const;
  };
 
} // namespace OpenMS