OpenMS  2.8.0
Public Member Functions | List of all members
ISpectraReader Class Referenceabstract

The interface of read-access to a list of spectra. More...

#include <OpenMS/INTERFACES/ISpectrumAccess.h>

Public Member Functions

virtual ~ISpectraReader ()
 
virtual SpectrumPtr getSpectrumById (int id) const =0
 Return a pointer to a spectrum at the given id. More...
 
virtual SpectrumPtr getSpectrumById (const std::string &id) const =0
 Return a pointer to a spectrum at the given string id. More...
 
virtual std::vector< std::size_t > getSpectraByRT (double RT, double deltaRT) const =0
 Return a vector of ids of spectra that are within RT +/- deltaRT. More...
 
virtual size_t getNrSpectra () const =0
 Returns the number of spectra available. More...
 
virtual SpectrumMetaPtr getSpectrumMetaById (int id) const =0
 Returns the meta information for a spectrum. More...
 

Detailed Description

The interface of read-access to a list of spectra.

Constructor & Destructor Documentation

◆ ~ISpectraReader()

virtual ~ISpectraReader ( )
inlinevirtual

Member Function Documentation

◆ getNrSpectra()

virtual size_t getNrSpectra ( ) const
pure virtual

Returns the number of spectra available.

◆ getSpectraByRT()

virtual std::vector<std::size_t> getSpectraByRT ( double  RT,
double  deltaRT 
) const
pure virtual

Return a vector of ids of spectra that are within RT +/- deltaRT.

◆ getSpectrumById() [1/2]

virtual SpectrumPtr getSpectrumById ( const std::string &  id) const
pure virtual

Return a pointer to a spectrum at the given string id.

◆ getSpectrumById() [2/2]

virtual SpectrumPtr getSpectrumById ( int  id) const
pure virtual

Return a pointer to a spectrum at the given id.

◆ getSpectrumMetaById()

virtual SpectrumMetaPtr getSpectrumMetaById ( int  id) const
pure virtual

Returns the meta information for a spectrum.