Gradient.h

Go to the documentation of this file.

// Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Marc Sturm $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/CONCEPT/Exception.h>
#include <OpenMS/DATASTRUCTURES/String.h>
 
#include <vector>
 
namespace OpenMS
{
  class OPENMS_DLLAPI Gradient
  {
public:
    Gradient() = default;
    Gradient(const Gradient &) = default;
    Gradient(Gradient&&) = default;
    ~Gradient();
 
    Gradient & operator=(const Gradient &) = default;
    Gradient& operator=(Gradient&&) & = default;
 
    bool operator==(const Gradient & source) const;
    bool operator!=(const Gradient & source) const;
 
    void addEluent(const String & eluent);
    void clearEluents();
    const std::vector<String> & getEluents() const;
 
    void addTimepoint(Int timepoint);
    void clearTimepoints();
    const std::vector<Int> & getTimepoints() const;
 
    void setPercentage(const String & eluent, Int timepoint, UInt percentage);
 
    const std::vector<std::vector<UInt> > & getPercentages() const;
 
    UInt getPercentage(const String & eluent, Int timepoint) const;
 
    void clearPercentages();
 
    bool isValid() const;
 
protected:
    std::vector<String> eluents_;
    std::vector<Int> times_;
    // first dimension is eluents, second is times
    std::vector<std::vector<UInt> > percentages_;
  };
 
} // namespace OpenMS