OpenMS  2.8.0
TOPPASResources.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-2021.
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 
44 
45 #include <QtCore/QString>
46 #include <QtCore/QObject>
47 
48 namespace OpenMS
49 {
55  class OPENMS_GUI_DLLAPI TOPPASResources :
56  QObject
57  {
58  Q_OBJECT
59 
60 public:
61 
67  ~TOPPASResources() override;
71  void add(const QString & key, const QList<TOPPASResource> & resource_list);
73  const QList<TOPPASResource> & get(const QString & key) const;
75  void load(const QString & file_name);
77  void store(const QString & file_name);
79  void clear();
80 
81 protected:
82 
86  QList<TOPPASResource> empty_list_;
87  };
88 }
89 
Map class based on the STL map (containing several convenience functions)
Definition: Map.h:52
A dictionary mapping string keys to lists of TOPPASResource objects.
Definition: TOPPASResources.h:57
TOPPASResources & operator=(const TOPPASResources &rhs)
Assignment operator.
Map< QString, QList< TOPPASResource > > map_
The dictionary.
Definition: TOPPASResources.h:84
TOPPASResources(const TOPPASResources &rhs)
Copy constructor.
void add(const QString &key, const QList< TOPPASResource > &resource_list)
Adds the (key,resource_list) pair to the dictionary.
void load(const QString &file_name)
Loads the dictionary from file file_name.
QList< TOPPASResource > empty_list_
The empty list.
Definition: TOPPASResources.h:86
TOPPASResources()
Constructor.
const QList< TOPPASResource > & get(const QString &key) const
Returns the resource list that key is mapped to, or an empty list if key does not exist.
~TOPPASResources() override
Destructor.
void clear()
Clears the dictionary.
void store(const QString &file_name)
Writes the dictionary to file file_name.
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47