OpenMS
TOPPASOutputVertex.h
Go to the documentation of this file.
1 // Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
2 // SPDX-License-Identifier: BSD-3-Clause
3 //
4 // --------------------------------------------------------------------------
5 // $Maintainer: Chris Bielow $
6 // $Authors: Chris Bielow $
7 // --------------------------------------------------------------------------
8 
9 #pragma once
10 
11 // OpenMS_GUI config
12 #include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
13 
15 
16 namespace OpenMS
17 {
23  class OPENMS_GUI_DLLAPI TOPPASOutputVertex : public TOPPASVertex
24  {
25  Q_OBJECT
26  public:
28  TOPPASOutputVertex() = default;
33 
34  // documented in base class
35  void reset(bool reset_all_files = false) override;
37  void mouseDoubleClickEvent(QGraphicsSceneMouseEvent*) override;
45  void setTopoNr(UInt nr) override;
47  void openContainingFolder() const;
50  void setOutputFolderName(const QString& name);
52  const QString& getOutputFolderName() const;
53 
54  signals:
56  void outputFileWritten(const String& file);
57 
60 
61  public slots:
62  // documented in base class
63  void inEdgeHasChanged() override;
64 
65  protected:
68 
69  // convenience members, not required for operation, but for progress during copying
70  int files_written_ = 0;
71  int files_total_ = 0;
72  };
73 
74 } // namespace OpenMS
75 
A more convenient string class.
Definition: String.h:34
A vertex representing an output, either folder or files(s)
Definition: TOPPASOutputVertex.h:24
void reset(bool reset_all_files=false) override
const QString & getOutputFolderName() const
return the output folder where results are written
void inEdgeHasChanged() override
String getFullOutputDirectory() const
Returns the full directory (including preceding output path as selected by user and a trailing '/')
TOPPASOutputVertex & operator=(const TOPPASOutputVertex &rhs)
Assignment operator.
void openContainingFolder() const
Opens the folders of the output files.
String getOutputDir() const
Returns the directory where the output files are stored (includes a trailing '/')
QString output_folder_name_
custom output folder name
Definition: TOPPASOutputVertex.h:67
void outputFileWritten(const String &file)
Emitted when an output file was written.
TOPPASOutputVertex()=default
Default C'tor.
TOPPASOutputVertex(const TOPPASOutputVertex &rhs)
Copy constructor.
void setOutputFolderName(const QString &name)
void mouseDoubleClickEvent(QGraphicsSceneMouseEvent *) override
opens the folder containing the output data
String createOutputDir() const
Creates the output directory for this node (includes a trailing '/')
void setTopoNr(UInt nr) override
Sets the topological sort number and removes invalidated tmp files.
void outputFolderNameChanged()
Emitted when user has changed the output folder name (i.e. output dir needs to be newly created and p...
The base class of the different vertex classes.
Definition: TOPPASVertex.h:78
unsigned int UInt
Unsigned integer type.
Definition: Types.h:64
Main OpenMS namespace.
Definition: openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19