ProteoWizard
Public Member Functions | Public Attributes
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

List of all members.

Public Member Functions

virtual size_t size () const
 returns the number of chromatograms
virtual bool empty () const
 returns true iff (size() == 0) and (dataProcessingPtr.get() == NULL)
virtual const
ChromatogramIdentity
chromatogramIdentity (size_t index) const
 access to a chromatogram index
virtual ChromatogramPtr chromatogram (size_t index, bool getBinaryData) const
 retrieve a chromatogram by index
virtual const
boost::shared_ptr< const
DataProcessing
dataProcessingPtr () const
 returns the data processing affecting spectra retrieved through this interface
- Public Member Functions inherited from pwiz::msdata::ChromatogramList
virtual size_t find (const std::string &id) const
 find id in the chromatogram index (returns size() on failure)
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 784 of file MSData.hpp.


Member Function Documentation

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

returns the number of chromatograms

Implements pwiz::msdata::ChromatogramList.

Definition at line 791 of file MSData.hpp.

{return chromatograms.size();}
virtual bool pwiz::msdata::ChromatogramListSimple::empty ( ) const
inlinevirtual

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

Reimplemented from pwiz::msdata::ChromatogramList.

Definition at line 792 of file MSData.hpp.

{return chromatograms.empty() && !dp.get();}
virtual const ChromatogramIdentity& pwiz::msdata::ChromatogramListSimple::chromatogramIdentity ( size_t  index) const
virtual

access to a chromatogram index

Implements pwiz::msdata::ChromatogramList.

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.

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

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

Definition at line 787 of file MSData.hpp.

Referenced by testChromatogramList(), and testChromatograms().


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