TOPPASToolVertex.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: Johannes Veit $
// $Authors: Johannes Junker, Chris Bielow $
// --------------------------------------------------------------------------
 
#pragma once
 
// OpenMS_GUI config
#include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
 
#include <OpenMS/VISUAL/TOPPASVertex.h>
#include <OpenMS/DATASTRUCTURES/Param.h>
#include <OpenMS/DATASTRUCTURES/ListUtils.h>
 
#include <QtCore/QVector>
 
namespace OpenMS
{
  class TOPPASScene;
 
  class OPENMS_GUI_DLLAPI TOPPASToolVertex :
    public TOPPASVertex
  {
    Q_OBJECT
 
public:
    enum TOOLSTATUS {TOOL_READY, TOOL_SCHEDULED, TOOL_RUNNING, TOOL_SUCCESS, TOOL_CRASH, TOOLSTATUS_SIZE};
 
    struct IOInfo
    {
      IOInfo() :
        type(IOT_FILE),
        param_name(),
        valid_types()
      {
      }
 
      IOInfo(const IOInfo& rhs) :
        type(rhs.type),
        param_name(rhs.param_name),
        valid_types(rhs.valid_types)
      {
      }
 
      enum IOType
      {
        IOT_FILE,
        IOT_LIST,
        IOT_DIR 
      };
 
      bool operator<(const IOInfo& rhs) const
      {
        if (type != rhs.type)
        {
          return type == IOT_FILE;
        }
        else
        {
          return param_name.compare(rhs.param_name) < 0;
        }
      }
      bool operator==(const IOInfo& rhs) const
      {
        return type == rhs.type && param_name == rhs.param_name;
      }
 
      IOInfo& operator=(const IOInfo& rhs)
      {
        type = rhs.type;
        param_name = rhs.param_name;
        valid_types = rhs.valid_types;
 
        return *this;
      }
 
      static bool isAnyList(const QVector<IOInfo>& params)
      {
        for (const auto& p : params)
        {
          if (p.type == IOT_LIST) return true;
        }
        return false;
      }
 
      IOType type;
      String param_name;
      StringList valid_types;
    };
 
    TOPPASToolVertex();
    TOPPASToolVertex(const String& name, const String& type = "");
    TOPPASToolVertex(const TOPPASToolVertex& rhs);
    ~TOPPASToolVertex() override = default;
    TOPPASToolVertex& operator=(const TOPPASToolVertex& rhs);
    
    virtual std::unique_ptr<TOPPASVertex> clone() const override;
 
    String getName() const override;
    const String& getType() const;
    QVector<IOInfo> getInputParameters() const;
    QVector<IOInfo> getOutputParameters() const;
    // documented in base class
    void paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget) override;
    // documented in base class
    QRectF boundingRect() const override;
    // documented in base class
    void setTopoNr(UInt nr) override;
    // documented in base class
    void reset(bool reset_all_files = false) override;
    void setParam(const Param& param);
    const Param& getParam();
    void run() override;
    bool updateCurrentOutputFileNames(const RoundPackages& pkg, String& error_message);
    TOOLSTATUS getStatus() const;
    void editParam();
    int numIterations();
    String getFullOutputDirectory() const;
    String getOutputDir() const;
    void createDirs();
    void openContainingFolder() const;
    void openInTOPPView();
    bool refreshParameters();
    bool isToolReady() const;
    void toggleBreakpoint();
    virtual void emitToolStarted();
    bool invertRecylingMode() override;
 
public slots:
 
    void executionFinished(int ec, QProcess::ExitStatus es);
    void forwardTOPPOutput();
    void toolStartedSlot();
    void toolFinishedSlot();
    void toolCrashedSlot();
    void toolFailedSlot();
    virtual void toolScheduledSlot();
    void inEdgeHasChanged() override;
    void outEdgeHasChanged() override;
 
signals:
 
    void toolStarted();
    void toolFinished();
    void toolCrashed();
    void toolFailed(int return_code = -1, const QString& message = "");
    void toppOutputReady(const QString& out);
 
protected:
 
 
    void mouseDoubleClickEvent(QGraphicsSceneMouseEvent* e) override;
  
 
    TOPPASScene* getScene_() const;
 
    bool doesParamChangeInvalidate_();
    bool renameOutput_();
    bool initParam_(const QString& old_ini_file = "");
    QVector<IOInfo> getParameters_(bool input_params) const;
    void writeParam_(const Param& param, const QString& ini_file);
    QString toolnameWithWhitespacesForFancyWordWrapping_(QPainter* painter, const QString& str);
    void smartFileNames_(std::vector<QStringList>& filenames);
 
    String name_;
    String type_;
    String tmp_path_;
    Param param_;
    TOOLSTATUS status_{TOOL_READY};
    bool tool_ready_{true};
    bool breakpoint_set_{false};
  };
}