ProteoWizard
Classes | Public Member Functions | Private Member Functions | Private Attributes
pwiz::analysis::SpectrumList_Filter Class Reference

SpectrumList filter, for creating Spectrum sub-lists. More...

#include <SpectrumList_Filter.hpp>

Inheritance diagram for pwiz::analysis::SpectrumList_Filter:
pwiz::msdata::SpectrumListWrapper pwiz::msdata::SpectrumList

List of all members.

Classes

struct  Predicate
 client-implemented filter predicate – called during construction of SpectrumList_Filter to create the filtered list of spectra More...

Public Member Functions

 SpectrumList_Filter (const msdata::SpectrumListPtr original, const Predicate &predicate)
SpectrumList interface
virtual size_t size () const
 returns the number of spectra
virtual const
msdata::SpectrumIdentity
spectrumIdentity (size_t index) const
 access to a spectrum index
virtual msdata::SpectrumPtr spectrum (size_t index, bool getBinaryData=false) const
 retrieve a spectrum by index
virtual msdata::SpectrumPtr spectrum (size_t index, msdata::DetailLevel detailLevel) const
 retrieve a spectrum by index
- Public Member Functions inherited from pwiz::msdata::SpectrumListWrapper
 SpectrumListWrapper (const SpectrumListPtr &inner)
virtual bool empty () const
 returns true iff (size() == 0) and (dataProcessingPtr.get() == NULL)
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::SpectrumList
virtual size_t find (const std::string &id) const
 find id in the spectrum index (returns size() on failure)
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 ()

Private Member Functions

 SpectrumList_Filter (SpectrumList_Filter &)
SpectrumList_Filteroperator= (SpectrumList_Filter &)

Private Attributes

boost::shared_ptr< Impl > impl_

Additional Inherited Members

- Protected Attributes inherited from pwiz::msdata::SpectrumListWrapper
SpectrumListPtr inner_
DataProcessingPtr dp_

Detailed Description

SpectrumList filter, for creating Spectrum sub-lists.

Definition at line 40 of file SpectrumList_Filter.hpp.


Constructor & Destructor Documentation

pwiz::analysis::SpectrumList_Filter::SpectrumList_Filter ( const msdata::SpectrumListPtr  original,
const Predicate predicate 
)
pwiz::analysis::SpectrumList_Filter::SpectrumList_Filter ( SpectrumList_Filter )
private

Member Function Documentation

virtual size_t pwiz::analysis::SpectrumList_Filter::size ( ) const
virtual
virtual const msdata::SpectrumIdentity& pwiz::analysis::SpectrumList_Filter::spectrumIdentity ( size_t  index) const
virtual
virtual msdata::SpectrumPtr pwiz::analysis::SpectrumList_Filter::spectrum ( size_t  index,
bool  getBinaryData = false 
) 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::SpectrumListWrapper.

Referenced by testEven().

virtual msdata::SpectrumPtr pwiz::analysis::SpectrumList_Filter::spectrum ( size_t  index,
msdata::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::SpectrumListWrapper.

SpectrumList_Filter& pwiz::analysis::SpectrumList_Filter::operator= ( SpectrumList_Filter )
private

Member Data Documentation

boost::shared_ptr<Impl> pwiz::analysis::SpectrumList_Filter::impl_
private

Definition at line 82 of file SpectrumList_Filter.hpp.


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