ProteoWizard
Public Member Functions | List of all members
pwiz::msdata::ChromatogramList Class Referenceabstract

Interface for accessing chromatograms, which may be stored in memory or backed by a data file (RAW, mzXML, mzML). More...

#include <MSData.hpp>

Inheritance diagram for pwiz::msdata::ChromatogramList:
pwiz::msdata::ChromatogramListBase pwiz::msdata::ChromatogramListSimple MyBase pwiz::msdata::ChromatogramList_mzML pwiz::msdata::detail::ChromatogramList_ABI pwiz::msdata::detail::ChromatogramList_Agilent pwiz::msdata::detail::ChromatogramList_Bruker pwiz::msdata::detail::ChromatogramList_Shimadzu pwiz::msdata::detail::ChromatogramList_Thermo pwiz::msdata::detail::ChromatogramList_Waters

Public Member Functions

virtual size_t size () const =0
 returns the number of chromatograms More...
 
bool empty () const
 returns true iff (size() == 0) and (dataProcessingPtr.get() == NULL) More...
 
virtual const ChromatogramIdentitychromatogramIdentity (size_t index) const =0
 access to a chromatogram index More...
 
virtual size_t find (const std::string &id) const
 find id in the chromatogram index (returns size() on failure) More...
 
virtual ChromatogramPtr chromatogram (size_t index, bool getBinaryData=false) const =0
 retrieve a chromatogram by index More...
 
virtual const boost::shared_ptr< const DataProcessingdataProcessingPtr () const
 returns the data processing affecting spectra retrieved through this interface More...
 
virtual ~ChromatogramList ()
 

Detailed Description

Interface for accessing chromatograms, which may be stored in memory or backed by a data file (RAW, mzXML, mzML).

Implementation notes:

Definition at line 752 of file MSData.hpp.

Constructor & Destructor Documentation

§ ~ChromatogramList()

virtual pwiz::msdata::ChromatogramList::~ChromatogramList ( )
inlinevirtual

Definition at line 777 of file MSData.hpp.

777 {}

Member Function Documentation

§ size()

virtual size_t pwiz::msdata::ChromatogramList::size ( ) const
pure virtual

§ empty()

bool pwiz::msdata::ChromatogramList::empty ( ) const

returns true iff (size() == 0) and (dataProcessingPtr.get() == NULL)

§ chromatogramIdentity()

virtual const ChromatogramIdentity& pwiz::msdata::ChromatogramList::chromatogramIdentity ( size_t  index) const
pure virtual

§ find()

virtual size_t pwiz::msdata::ChromatogramList::find ( const std::string &  id) const
virtual

§ chromatogram()

virtual ChromatogramPtr pwiz::msdata::ChromatogramList::chromatogram ( size_t  index,
bool  getBinaryData = false 
) const
pure virtual

§ dataProcessingPtr()

virtual const boost::shared_ptr<const DataProcessing> pwiz::msdata::ChromatogramList::dataProcessingPtr ( ) const
virtual

returns the data processing affecting spectra retrieved through this interface

  • may return a null shared pointer

Reimplemented in pwiz::msdata::ChromatogramListSimple, pwiz::msdata::ChromatogramListBase, and MyBase.

Referenced by pwiz::msdata::TextWriter::operator()(), and testChromatograms().


The documentation for this class was generated from the following file: