Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Member Functions | List of all members
IChromatogramsReader Class Referenceabstract

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

#include <OpenMS/INTERFACES/ISpectrumAccess.h>

Public Member Functions

virtual ~IChromatogramsReader ()
 
virtual ChromatogramPtr getChromatogramById (int id) const =0
 Return a pointer to a chromatogram at the given id. More...
 
virtual ChromatogramPtr getChromatogramById (const std::string &id) const =0
 Return a pointer to a chromatogram at the given string id. More...
 
virtual std::vector< std::size_t > getChromatogramByPrecursorMZ (double mz, double deltaMZ) const =0
 Return a vector of ids of chromatograms that are within mz +/- deltaMz. More...
 
virtual std::size_t getNrChromatograms () const =0
 Returns the number of chromatograms available. More...
 
virtual ChromatogramMetaPtr getChromatogramMetaById (int id) const =0
 Returns the meta information for a chromatogram. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ~IChromatogramsReader()

virtual ~IChromatogramsReader ( )
inlinevirtual

Member Function Documentation

◆ getChromatogramById() [1/2]

virtual ChromatogramPtr getChromatogramById ( int  id) const
pure virtual

Return a pointer to a chromatogram at the given id.

◆ getChromatogramById() [2/2]

virtual ChromatogramPtr getChromatogramById ( const std::string &  id) const
pure virtual

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

◆ getChromatogramByPrecursorMZ()

virtual std::vector<std::size_t> getChromatogramByPrecursorMZ ( double  mz,
double  deltaMZ 
) const
pure virtual

Return a vector of ids of chromatograms that are within mz +/- deltaMz.

◆ getChromatogramMetaById()

virtual ChromatogramMetaPtr getChromatogramMetaById ( int  id) const
pure virtual

Returns the meta information for a chromatogram.

◆ getNrChromatograms()

virtual std::size_t getNrChromatograms ( ) const
pure virtual

Returns the number of chromatograms available.


OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:22:14 using doxygen 1.8.13