IMSExperimentRandomAccess.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Julianus Pfeuffer $
// $Authors: Julianus Pfeuffer $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/KERNEL/MSChromatogram.h>
#include <OpenMS/KERNEL/MSSpectrum.h>
#include <OpenMS/OpenMSConfig.h>
 
#include <memory>
 
namespace OpenMS
{
  class ExperimentalSettings;
 
  class OPENMS_DLLAPI IMSExperimentRandomAccess
  {
  public:
    virtual ~IMSExperimentRandomAccess();
 
    virtual Size getNrSpectra() const = 0;
 
    virtual Size getNrChromatograms() const = 0;
 
    Size size() const
    {
      return getNrSpectra();
    }
 
    bool empty() const
    {
      return getNrSpectra() == 0;
    }
 
    virtual MSSpectrum getSpectrum(Size index) = 0;
 
    virtual MSSpectrum getSpectrumMetadata(Size index) = 0;
 
    virtual MSSpectrum getSpectrumPeaks(Size index);
 
    virtual double getSpectrumRT(Size index) const = 0;
 
    virtual UInt getSpectrumMSLevel(Size index) const = 0;
 
    virtual bool isSortedByRT() const = 0;
 
    virtual Size findFirstRT(double rt) const;
 
    virtual MSChromatogram getChromatogram(Size index) = 0;
 
    virtual std::shared_ptr<const ExperimentalSettings> getExperimentalSettings() const = 0;
 
    virtual std::unique_ptr<IMSExperimentRandomAccess> clone() const = 0;
 
  protected:
    IMSExperimentRandomAccess() = default;
    IMSExperimentRandomAccess(const IMSExperimentRandomAccess&) = default;
    IMSExperimentRandomAccess& operator=(const IMSExperimentRandomAccess&) = default;
  };
} // namespace OpenMS