Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
MassDecomposition.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-2017.
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 #ifndef OPENMS_CHEMISTRY_MASSDECOMPOSITION_MASSDECOMPOSITION_H
36 #define OPENMS_CHEMISTRY_MASSDECOMPOSITION_MASSDECOMPOSITION_H
37 
38 #include <OpenMS/config.h>
39 #include <OpenMS/CONCEPT/Types.h>
40 
41 #include <map>
42 
43 namespace OpenMS
44 {
45  class String;
46 
54  class OPENMS_DLLAPI MassDecomposition
55  {
56 public:
57 
64 
67 
69  explicit MassDecomposition(const String& deco);
71 
76  MassDecomposition& operator=(const MassDecomposition& rhs);
78 
80  MassDecomposition& operator+=(const MassDecomposition& d);
81 
83  String toString() const;
84 
86  String toExpandedString() const;
87 
89  MassDecomposition operator+(const MassDecomposition& rhs) const;
90 
92  Size getNumberOfMaxAA() const;
94 
99  bool operator<(const MassDecomposition& rhs) const;
101 
103  bool operator==(const String& deco) const;
104 
106  bool containsTag(const String& tag) const;
107 
109  bool compatible(const MassDecomposition& deco) const;
111 
112 protected:
113  std::map<char, Size> decomp_;
115  };
116 } // namespace OpenMS
117 
118 #endif // OPENMS_CHEMISTRY_MASSDECOMPOSITION_MASSDECOMPOSITION_H
A more convenient string class.
Definition: String.h:57
Size number_of_max_aa_
Definition: MassDecomposition.h:114
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
bool operator<(const MultiplexDeltaMasses &dm1, const MultiplexDeltaMasses &dm2)
std::map< char, Size > decomp_
Definition: MassDecomposition.h:113
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:128
Class represents a decomposition of a mass into amino acids.
Definition: MassDecomposition.h:54
String toString(T i)
toString functions (single argument)
Definition: StringUtils.h:69

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:22:01 using doxygen 1.8.13