OpenMS  2.8.0
ProteaseDB.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: Xiao Liang $
32 // $Authors: Xiao Liang, Chris Bielow $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
40 
41 #include <vector>
42 
43 namespace OpenMS
44 {
52  class OPENMS_DLLAPI ProteaseDB: public DigestionEnzymeDB<DigestionEnzymeProtein, ProteaseDB>
53  {
54  // allow access to constructor in DigestionEnzymeDB::getInstance():
56 
57  protected:
60 
61  public:
63  void getAllXTandemNames(std::vector<String>& all_names) const;
64 
66  void getAllCometNames(std::vector<String>& all_names) const;
67 
69  void getAllCruxNames(std::vector<String>& all_names) const;
70 
72  void getAllOMSSANames(std::vector<String>& all_names) const;
73 
75  void getAllMSGFNames(std::vector<String>& all_names) const;
76 
78  void writeTSV(const String& filename);
79  };
80 }
81 
82 
Digestion enzyme database (base class)
Definition: DigestionEnzymeDB.h:58
Representation of a digestion enzyme for proteins (protease)
Definition: DigestionEnzymeProtein.h:50
Database for enzymes that digest proteins (proteases)
Definition: ProteaseDB.h:53
void getAllOMSSANames(std::vector< String > &all_names) const
returns all the enzyme names available for OMSSA
void writeTSV(const String &filename)
writes the full names to a TSV file
ProteaseDB()
constructor
void getAllCometNames(std::vector< String > &all_names) const
returns all the enzyme names available for Comet
void getAllMSGFNames(std::vector< String > &all_names) const
returns all the enzyme names available for MSGFPlus
void getAllCruxNames(std::vector< String > &all_names) const
returns all the enzyme names available for Crux
void getAllXTandemNames(std::vector< String > &all_names) const
returns all the enzyme names available for XTandem
A more convenient string class.
Definition: String.h:60
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47