ProteoWizard
Public Member Functions | Public Attributes | List of all members
pwiz::msdata::ChromatogramListSimple Struct Reference

Simple writeable in-memory implementation of ChromatogramList. More...

#include <MSData.hpp>

Inheritance diagram for pwiz::msdata::ChromatogramListSimple:
pwiz::msdata::ChromatogramList

Public Member Functions

virtual size_t size () const
 returns the number of chromatograms More...
 
virtual bool empty () const
 
virtual const ChromatogramIdentitychromatogramIdentity (size_t index) const
 access to a chromatogram index More...
 
virtual ChromatogramPtr chromatogram (size_t index, bool getBinaryData) const
 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...
 
- Public Member Functions inherited from pwiz::msdata::ChromatogramList
bool empty () const
 returns true iff (size() == 0) and (dataProcessingPtr.get() == NULL) More...
 
virtual size_t find (const std::string &id) const
 find id in the chromatogram index (returns size() on failure) More...
 
virtual ~ChromatogramList ()
 

Public Attributes

std::vector< ChromatogramPtrchromatograms
 
DataProcessingPtr dp
 

Detailed Description

Simple writeable in-memory implementation of ChromatogramList.

Note: This chromatogram() implementation returns internal ChromatogramPtrs.

Definition at line 786 of file MSData.hpp.

Member Function Documentation

§ size()

virtual size_t pwiz::msdata::ChromatogramListSimple::size ( ) const
inlinevirtual

returns the number of chromatograms

Implements pwiz::msdata::ChromatogramList.

Definition at line 793 of file MSData.hpp.

793 {return chromatograms.size();}
std::vector< ChromatogramPtr > chromatograms
Definition: MSData.hpp:788

§ empty()

virtual bool pwiz::msdata::ChromatogramListSimple::empty ( ) const
inlinevirtual

Definition at line 794 of file MSData.hpp.

794 {return chromatograms.empty() && !dp.get();}
std::vector< ChromatogramPtr > chromatograms
Definition: MSData.hpp:788

§ chromatogramIdentity()

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

access to a chromatogram index

Implements pwiz::msdata::ChromatogramList.

§ chromatogram()

virtual ChromatogramPtr pwiz::msdata::ChromatogramListSimple::chromatogram ( size_t  index,
bool  getBinaryData 
) const
virtual

retrieve a chromatogram by index

  • binary data arrays will be provided if (getBinaryData == true);
  • client may assume the underlying Chromatogram* is valid

Implements pwiz::msdata::ChromatogramList.

§ dataProcessingPtr()

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

returns the data processing affecting spectra retrieved through this interface

  • may return a null shared pointer

Reimplemented from pwiz::msdata::ChromatogramList.

Member Data Documentation

§ chromatograms

std::vector<ChromatogramPtr> pwiz::msdata::ChromatogramListSimple::chromatograms

§ dp

DataProcessingPtr pwiz::msdata::ChromatogramListSimple::dp

Definition at line 789 of file MSData.hpp.

Referenced by testChromatogramList(), and testChromatograms().


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