| OpenMS 2.5.0

TOPPASOutputFileListVertex.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-2020.
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: Johannes Veit $
32 // $Authors: Johannes Junker, Chris Bielow $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 // OpenMS_GUI config
38 #include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
39
40 #include <OpenMS/VISUAL/TOPPASVertex.h>
41
42 namespace OpenMS
43 {
49 class OPENMS_GUI_DLLAPI TOPPASOutputFileListVertex :
50 public TOPPASVertex
51 {
52 Q_OBJECT
53
54 public:
55
57 TOPPASOutputFileListVertex() = default;
59 TOPPASOutputFileListVertex(const TOPPASOutputFileListVertex & rhs);
61 ~TOPPASOutputFileListVertex() override = default;
63 TOPPASOutputFileListVertex & operator=(const TOPPASOutputFileListVertex & rhs);
65 String getName() const override;
66 // documented in base class
67 void paint(QPainter * painter, const QStyleOptionGraphicsItem * option, QWidget * widget) override;
68 // documented in base class
69 QRectF boundingRect() const override;
70 // documented in base class
71 void reset(bool reset_all_files = false) override;
73 void run() override;
75 String getFullOutputDirectory() const;
77 String getOutputDir() const;
79 String createOutputDir();
81 void setTopoNr(UInt nr) override;
83 void openContainingFolder();
86 void setOutputFolderName(const QString& name);
88 const QString& getOutputFolderName() const;
89
90 public slots:
91
92 //documented in base class
93 void inEdgeHasChanged() override;
94
95 signals:
97 void outputFileWritten(const String& file);
98
100 void outputFolderNameChanged();
101
102 protected:
103
104 // custom output folder name
105 QString output_folder_name_;
106
107 static bool copy_(const QString & from, const QString & to);
108 // convenience members, not required for operation, but for progress during copying
109 int files_written_ = 0;
110 int files_total_ = 0;
111 };
112 }
113
OpenMS::String
A more convenient string class.
Definition: String.h:58
QWidget
OpenMS::TOPPASOutputFileListVertex::output_folder_name_
QString output_folder_name_
Definition: TOPPASOutputFileListVertex.h:105
TOPPASVertex.h
OpenMS::TOPPASOutputFileListVertex
A vertex representing an output file list.
Definition: TOPPASOutputFileListVertex.h:49
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::UInt
unsigned int UInt
Unsigned integer type.
Definition: Types.h:94
OpenMS::TOPPASVertex
The base class of the different vertex classes.
Definition: TOPPASVertex.h:101