OpenMS  3.0.0
CrossLinksDB.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-2022.
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: Timo Sachsenberg $
32 // $Authors: Andreas Bertsch $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
38 
39 namespace OpenMS
40 {
41  class OPENMS_DLLAPI CrossLinksDB :
42  public ModificationsDB
43  {
44  public:
45 
47  inline static CrossLinksDB* getInstance()
48  {
49  static CrossLinksDB* db_ = new CrossLinksDB;
50  return db_;
51  }
52 
60  void readFromOBOFile(const String& filename);
61 
63  void getAllSearchModifications(std::vector<String>& modifications) const;
64 
65  private:
66 
70  CrossLinksDB();
72 
74  CrossLinksDB(const CrossLinksDB& residue_db);
75 
77  ~CrossLinksDB() override;
79 
83  CrossLinksDB & operator=(const CrossLinksDB& aa);
86 
87  };
88 }
89 
OpenMS::CrossLinksDB::getInstance
static CrossLinksDB * getInstance()
Returns a pointer to the modifications DB (singleton)
Definition: CrossLinksDB.h:47
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::ModificationsDB
database which holds all residue modifications from UniMod
Definition: ModificationsDB.h:75
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
ModificationsDB.h
OpenMS::CrossLinksDB
Definition: CrossLinksDB.h:41