Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Gradient.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: Marc Sturm $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_METADATA_GRADIENT_H
36 #define OPENMS_METADATA_GRADIENT_H
37 
40 
41 #include <vector>
42 
43 namespace OpenMS
44 {
53  class OPENMS_DLLAPI Gradient
54  {
55 public:
57  Gradient();
59  Gradient(const Gradient & source);
61  ~Gradient();
62 
64  Gradient & operator=(const Gradient & source);
65 
67  bool operator==(const Gradient & source) const;
69  bool operator!=(const Gradient & source) const;
70 
76  void addEluent(const String & eluent);
78  void clearEluents();
80  const std::vector<String> & getEluents() const;
81 
87  void addTimepoint(Int timepoint);
89  void clearTimepoints();
91  const std::vector<Int> & getTimepoints() const;
92 
98  void setPercentage(const String & eluent, Int timepoint, UInt percentage);
99 
105  const std::vector<std::vector<UInt> > & getPercentages() const;
106 
112  UInt getPercentage(const String & eluent, Int timepoint) const;
113 
115  void clearPercentages();
116 
118  bool isValid() const;
119 
120 protected:
121  std::vector<String> eluents_;
122  std::vector<Int> times_;
123  // first dimension is eluents, second is times
124  std::vector<std::vector<UInt> > percentages_;
125  };
126 
127 } // namespace OpenMS
128 
129 #endif // OPENMS_METADATA_GRADIENT_H
A more convenient string class.
Definition: String.h:57
std::vector< Int > times_
Definition: Gradient.h:122
unsigned int UInt
Unsigned integer type.
Definition: Types.h:95
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
Representation of a HPLC gradient.
Definition: Gradient.h:53
std::vector< std::vector< UInt > > percentages_
Definition: Gradient.h:124
std::vector< String > eluents_
Definition: Gradient.h:121
bool operator!=(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:824
int Int
Signed integer type.
Definition: Types.h:103

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