ProteoWizard
Public Member Functions
pwiz::msdata::detail::SpectrumList_ABI Class Reference

#include <SpectrumList_ABI.hpp>

Inheritance diagram for pwiz::msdata::detail::SpectrumList_ABI:
pwiz::msdata::SpectrumListBase pwiz::msdata::SpectrumList

List of all members.

Public Member Functions

virtual size_t size () const
 returns the number of spectra
virtual const SpectrumIdentityspectrumIdentity (size_t index) const
 access to a spectrum index
virtual size_t find (const std::string &id) const
 find id in the spectrum index (returns size() on failure)
virtual SpectrumPtr spectrum (size_t index, bool getBinaryData) const
 retrieve a spectrum by index
virtual SpectrumPtr spectrum (size_t index, DetailLevel detailLevel) const
 retrieve a spectrum by index
virtual SpectrumPtr spectrum (size_t index, bool getBinaryData, const pwiz::util::IntegerSet &msLevelsToCentroid) const
virtual SpectrumPtr spectrum (size_t index, DetailLevel detailLevel, const pwiz::util::IntegerSet &msLevelsToCentroid) const
- Public Member Functions inherited from pwiz::msdata::SpectrumListBase
virtual const
boost::shared_ptr< const
DataProcessing
dataProcessingPtr () const
 implementation of SpectrumList
virtual void setDataProcessingPtr (DataProcessingPtr dp)
 set DataProcessing
- Public Member Functions inherited from pwiz::msdata::SpectrumList
virtual bool empty () const
 returns true iff (size() == 0) and (dataProcessingPtr.get() == NULL)
virtual IndexList findNameValue (const std::string &name, const std::string &value) const
 find all spectrum indexes with specified name/value pair
virtual IndexList findSpotID (const std::string &spotID) const
 find all spectrum indexes with spotID (returns empty vector on failure)
virtual SpectrumPtr spectrum (const SpectrumPtr &seed, bool getBinaryData) const
 get a copy of the seed spectrum, optionally with its binary data populated this is useful for formats like mzML that can delay loading of binary data
virtual ~SpectrumList ()

Additional Inherited Members

- Protected Attributes inherited from pwiz::msdata::SpectrumListBase
DataProcessingPtr dp_

Detailed Description

Definition at line 39 of file SpectrumList_ABI.hpp.


Member Function Documentation

virtual size_t pwiz::msdata::detail::SpectrumList_ABI::size ( ) const
virtual

returns the number of spectra

Implements pwiz::msdata::SpectrumList.

virtual const SpectrumIdentity& pwiz::msdata::detail::SpectrumList_ABI::spectrumIdentity ( size_t  index) const
virtual

access to a spectrum index

Implements pwiz::msdata::SpectrumList.

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

find id in the spectrum index (returns size() on failure)

Reimplemented from pwiz::msdata::SpectrumList.

virtual SpectrumPtr pwiz::msdata::detail::SpectrumList_ABI::spectrum ( size_t  index,
bool  getBinaryData 
) const
virtual

retrieve a spectrum by index

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

Implements pwiz::msdata::SpectrumList.

virtual SpectrumPtr pwiz::msdata::detail::SpectrumList_ABI::spectrum ( size_t  index,
DetailLevel  detailLevel 
) const
virtual

retrieve a spectrum by index

  • detailLevel determines what fields are guaranteed present on the spectrum after the call
  • client may assume the underlying Spectrum* is valid

Reimplemented from pwiz::msdata::SpectrumList.

virtual SpectrumPtr pwiz::msdata::detail::SpectrumList_ABI::spectrum ( size_t  index,
bool  getBinaryData,
const pwiz::util::IntegerSet msLevelsToCentroid 
) const
virtual
virtual SpectrumPtr pwiz::msdata::detail::SpectrumList_ABI::spectrum ( size_t  index,
DetailLevel  detailLevel,
const pwiz::util::IntegerSet msLevelsToCentroid 
) const
virtual

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