OpenMS
TOPPASResource.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-2023.
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 $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 // OpenMS_GUI config
38 #include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
39 
40 #include <QtCore/QString>
41 #include <QtCore/QStringList>
42 #include <QtCore/QUrl>
43 #include <QtCore/QObject>
44 
45 namespace OpenMS
46 {
54  class OPENMS_GUI_DLLAPI TOPPASResource :
55  QObject
56  {
57  Q_OBJECT
58 
59 public:
60 
62  TOPPASResource(const QString & file);
64  TOPPASResource(const QUrl & url);
68  ~TOPPASResource() override;
72  void writeToFile(const QString & file_name);
74  const QString & getLocalFile() const;
76  const QUrl & getURL() const;
78  void fromLocalFile(const QString & file);
79 
81  static QStringList supported_schemes;
82 
83 protected:
84 
86  QUrl url_;
88  QString file_name_;
89  };
90 }
91 
Represents a data resource for TOPPAS workflows.
Definition: TOPPASResource.h:56
~TOPPASResource() override
Destructor.
const QString & getLocalFile() const
Returns the file name of the local file, or "" if it has not been written yet.
TOPPASResource(const QUrl &url)
Constructor from URL.
const QUrl & getURL() const
Returns the URL of this resource.
static QStringList supported_schemes
Supported schemes.
Definition: TOPPASResource.h:81
TOPPASResource(const QString &file)
Constructor.
QString file_name_
The name of the local file.
Definition: TOPPASResource.h:88
void writeToFile(const QString &file_name)
Writes this resource to the local file file.
void fromLocalFile(const QString &file)
Sets the URL of this resource from file.
TOPPASResource & operator=(const TOPPASResource &rhs)
Assignment operator.
QUrl url_
The URL of this resource.
Definition: TOPPASResource.h:86
TOPPASResource(const TOPPASResource &rhs)
Copy constructor.
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48