OpenMS  2.5.0
Digestion.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-2020.
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 
39 
40 namespace OpenMS
41 {
49  class OPENMS_DLLAPI Digestion :
50  public SampleTreatment
51  {
52 public:
54  Digestion();
56  Digestion(const Digestion &) = default;
58  Digestion(Digestion&&) = default;
60  ~Digestion() override;
61 
63  Digestion & operator=(const Digestion &) = default;
65  Digestion& operator=(Digestion&&) & = default;
66 
73  bool operator==(const SampleTreatment & rhs) const override;
74 
76  SampleTreatment * clone() const override;
77 
79  const String & getEnzyme() const;
81  void setEnzyme(const String & enzyme);
82 
84  double getDigestionTime() const;
86  void setDigestionTime(double digestion_time);
87 
89  double getTemperature() const;
91  void setTemperature(double temperature);
92 
94  double getPh() const;
96  void setPh(double ph);
97 
98 protected:
101  double temperature_;
102  double ph_;
103  };
104 } // namespace OpenMS
105 
OpenMS::Digestion::digestion_time_
double digestion_time_
Definition: Digestion.h:100
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::Digestion::enzyme_
String enzyme_
Definition: Digestion.h:99
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::SampleTreatment
Base class for sample treatments (Digestion, Modification, Tagging, ...)
Definition: SampleTreatment.h:51
OpenMS::Digestion::temperature_
double temperature_
Definition: Digestion.h:101
SampleTreatment.h
OpenMS::Digestion::ph_
double ph_
Definition: Digestion.h:102
KDTree::operator==
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806
String.h
OpenMS::Digestion
Meta information about digestion of a sample.
Definition: Digestion.h:49