← Back to branch summary

~ubuntu-branches/ubuntu/wily/openms/wily

« back to all changes in this revision

Viewing changes to include/OpenMS/METADATA/Digestion.h

  • Committer: Package Import Robot
  • Author(s): Filippo Rusconi
  • Date: 2012-11-12 15:58:12 UTC
  • Revision ID: package-import@ubuntu.com-20121112155812-vr15wtg9b50cuesg
Tags: upstream-1.9.0
Import upstream version 1.9.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/OpenMS/METADATA/Digestion.h
 
1
// -*- mode: C++; tab-width: 2; -*-
 
2
// vi: set ts=2:
 
3
//
 
4
// --------------------------------------------------------------------------
 
5
//                   OpenMS Mass Spectrometry Framework
 
6
// --------------------------------------------------------------------------
 
7
//  Copyright (C) 2003-2011 -- Oliver Kohlbacher, Knut Reinert
 
8
//
 
9
//  This library is free software; you can redistribute it and/or
 
10
//  modify it under the terms of the GNU Lesser General Public
 
11
//  License as published by the Free Software Foundation; either
 
12
//  version 2.1 of the License, or (at your option) any later version.
 
13
// 
 
14
//  This library is distributed in the hope that it will be useful,
 
15
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
 
16
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
17
//  Lesser General Public License for more details.
 
18
//
 
19
//  You should have received a copy of the GNU Lesser General Public
 
20
//  License along with this library; if not, write to the Free Software
 
21
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
22
//
 
23
// --------------------------------------------------------------------------
 
24
// $Maintainer: Andreas Bertsch $
 
25
// $Authors: Marc Sturm $
 
26
// --------------------------------------------------------------------------
 
27
 
 
28
#ifndef OPENMS_METADATA_DIGESTION_H
 
29
#define OPENMS_METADATA_DIGESTION_H
 
30
 
 
31
#include <OpenMS/DATASTRUCTURES/String.h>
 
32
#include <OpenMS/METADATA/SampleTreatment.h>
 
33
 
 
34
namespace OpenMS 
 
35
{
 
36
        /**
 
37
                @brief Meta information about digestion of a sample
 
38
                
 
39
                Representation of a digestion.
 
40
                
 
41
                @ingroup Metadata
 
42
        */
 
43
  class OPENMS_DLLAPI Digestion: public SampleTreatment
 
44
  {
 
45
    public:
 
46
        /// default constructor
 
47
        Digestion();
 
48
        /// copy constructor
 
49
        Digestion(const Digestion&);
 
50
        /// destructor
 
51
        virtual ~Digestion();
 
52
 
 
53
                        /// assignment operator
 
54
        Digestion& operator=(const Digestion&);
 
55
 
 
56
        /**
 
57
                @brief Equality operator
 
58
        
 
59
        Although this operator takes a reference to a SampleTreatment as argument
 
60
        it tests for the equality of Tagging instances!
 
61
      */
 
62
      virtual bool operator== (const SampleTreatment& rhs) const;
 
63
                        
 
64
                        /// clone method. See SampleTreatment
 
65
                        virtual SampleTreatment* clone() const;
 
66
                        
 
67
                        /// returns the enzyme name (default is "")
 
68
                  const String& getEnzyme() const;
 
69
                  /// sets the enzyme name
 
70
                  void setEnzyme(const String& enzyme);
 
71
                
 
72
                        /// returns the digestion time in minutes (default is 0.0)
 
73
                  DoubleReal getDigestionTime() const;
 
74
                  /// sets the digestion time in minutes
 
75
                  void setDigestionTime(DoubleReal digestion_time);
 
76
                
 
77
                        /// return the temperature during digestion in degree C (default is 0.0)
 
78
                  DoubleReal getTemperature() const;
 
79
                  /// sets the temperature during digestion in degree C
 
80
                  void setTemperature(DoubleReal temperature);
 
81
                
 
82
                        /// returns the pH value (default is 0.0)
 
83
                  DoubleReal getPh() const;
 
84
                  /// sets the pH value
 
85
                  void setPh(DoubleReal ph);                    
 
86
 
 
87
    protected:
 
88
                        String enzyme_;
 
89
                        DoubleReal digestion_time_;
 
90
                        DoubleReal temperature_;
 
91
                        DoubleReal ph_;
 
92
  };
 
93
} // namespace OpenMS
 
94
 
 
95
#endif // OPENMS_METADATA_DIGESTION_H
 
96
 
 
97
 
 
98