OpenMS  3.0.0
Tagging.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: Marc Sturm $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
38 
39 namespace OpenMS
40 {
49  class OPENMS_DLLAPI Tagging :
50  public Modification
51  {
52 public:
54  enum IsotopeVariant {LIGHT, HEAVY, SIZE_OF_ISOTOPEVARIANT};
56  static const std::string NamesOfIsotopeVariant[SIZE_OF_ISOTOPEVARIANT];
57 
59  Tagging();
61  Tagging(const Tagging &) = default;
63  Tagging(Tagging&&) = default;
65  ~Tagging() override;
66 
68  Tagging & operator=(const Tagging &) = default;
70  Tagging& operator=(Tagging&&) & = default;
71 
78  bool operator==(const SampleTreatment & rhs) const override;
79 
81  SampleTreatment * clone() const override;
82 
84  double getMassShift() const;
86  void setMassShift(double mass_shift);
87 
89  const IsotopeVariant & getVariant() const;
91  void setVariant(const IsotopeVariant & variant);
92 
93 protected:
94  double mass_shift_;
96  };
97 } // namespace OpenMS
98 
OpenMS::Modification
Meta information about chemical modification of a sample.
Definition: Modification.h:51
OpenMS::Tagging::IsotopeVariant
IsotopeVariant
Isotope variants (light and heavy)
Definition: Tagging.h:54
OpenMS::Tagging
Meta information about tagging of a sample e.g. ICAT labeling.
Definition: Tagging.h:49
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::Tagging::variant_
IsotopeVariant variant_
Definition: Tagging.h:95
OpenMS::SampleTreatment
Base class for sample treatments (Digestion, Modification, Tagging, ...)
Definition: SampleTreatment.h:51
OpenMS::Tagging::mass_shift_
double mass_shift_
Definition: Tagging.h:94
Modification.h
OpenMS::Internal::operator==
bool operator==(const IDBoostGraph::ProteinGroup &lhs, const IDBoostGraph::ProteinGroup &rhs)