OpenMS  3.0.0
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-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 
39 
40 #include <vector>
41 
42 namespace OpenMS
43 {
52  class OPENMS_DLLAPI Gradient
53  {
54 public:
56  Gradient() = default;
58  Gradient(const Gradient &) = default;
60  Gradient(Gradient&&) = default;
62  ~Gradient();
63 
65  Gradient & operator=(const Gradient &) = default;
67  Gradient& operator=(Gradient&&) & = default;
68 
70  bool operator==(const Gradient & source) const;
72  bool operator!=(const Gradient & source) const;
73 
79  void addEluent(const String & eluent);
81  void clearEluents();
83  const std::vector<String> & getEluents() const;
84 
90  void addTimepoint(Int timepoint);
92  void clearTimepoints();
94  const std::vector<Int> & getTimepoints() const;
95 
101  void setPercentage(const String & eluent, Int timepoint, UInt percentage);
102 
108  const std::vector<std::vector<UInt> > & getPercentages() const;
109 
115  UInt getPercentage(const String & eluent, Int timepoint) const;
116 
118  void clearPercentages();
119 
121  bool isValid() const;
122 
123 protected:
124  std::vector<String> eluents_;
125  std::vector<Int> times_;
126  // first dimension is eluents, second is times
127  std::vector<std::vector<UInt> > percentages_;
128  };
129 
130 } // namespace OpenMS
131 
OpenMS::Gradient::times_
std::vector< Int > times_
Definition: Gradient.h:125
OpenMS::Gradient::percentages_
std::vector< std::vector< UInt > > percentages_
Definition: Gradient.h:127
OpenMS::Gradient::eluents_
std::vector< String > eluents_
Definition: Gradient.h:124
OpenMS::String
A more convenient string class.
Definition: String.h:58
KDTree::operator!=
bool operator!=(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:824
OpenMS::Int
int Int
Signed integer type.
Definition: Types.h:102
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
Exception.h
OpenMS::UInt
unsigned int UInt
Unsigned integer type.
Definition: Types.h:94
OpenMS::Internal::operator==
bool operator==(const IDBoostGraph::ProteinGroup &lhs, const IDBoostGraph::ProteinGroup &rhs)
String.h
OpenMS::Gradient
Representation of a HPLC gradient.
Definition: Gradient.h:52