openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.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: Hannes Roest $
// $Authors: Hannes Roest, Witold Wolski $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/OPENSWATHALGO/OpenSwathAlgoConfig.h>
 
#include <OpenMS/OPENSWATHALGO/DATAACCESS/DataStructures.h>
#include <boost/shared_ptr.hpp>
#include <string>
#include <vector>
 
namespace OpenSwath
{
 
  class OPENSWATHALGO_DLLAPI ISpectrumAccess
  {
public:
    virtual ~ISpectrumAccess();
 
    virtual boost::shared_ptr<ISpectrumAccess> lightClone() const = 0;
 
    virtual SpectrumPtr getSpectrumById(int id) = 0;
    virtual std::vector<std::size_t> getSpectraByRT(double RT, double deltaRT) const = 0;
    virtual size_t getNrSpectra() const = 0;
    virtual SpectrumMeta getSpectrumMetaById(int id) const = 0;
 
    virtual ChromatogramPtr getChromatogramById(int id) = 0;
    virtual std::size_t getNrChromatograms() const = 0;
    virtual std::string getChromatogramNativeID(int id) const = 0;
  };
 
  typedef boost::shared_ptr<ISpectrumAccess> SpectrumAccessPtr;
}