ProteoWizard
Classes | Public Member Functions | Private Member Functions | Private Attributes | List of all members
pwiz::analysis::ChromatogramList_Filter Class Reference

ChromatogramList filter, for creating Chromatogram sub-lists. More...

#include <ChromatogramList_Filter.hpp>

Inheritance diagram for pwiz::analysis::ChromatogramList_Filter:
pwiz::analysis::ChromatogramListWrapper pwiz::msdata::ChromatogramList

Classes

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

Public Member Functions

 ChromatogramList_Filter (const msdata::ChromatogramListPtr original, const Predicate &predicate)
 
ChromatogramList interface
virtual size_t size () const
 returns the number of chromatograms More...
 
virtual const msdata::ChromatogramIdentitychromatogramIdentity (size_t index) const
 access to a chromatogram index More...
 
virtual msdata::ChromatogramPtr chromatogram (size_t index, bool getBinaryData=false) const
 retrieve a chromatogram by index More...
 
- Public Member Functions inherited from pwiz::analysis::ChromatogramListWrapper
 ChromatogramListWrapper (const msdata::ChromatogramListPtr &inner)
 
virtual bool empty () const
 
virtual size_t find (const std::string &id) const
 find id in the chromatogram index (returns size() on failure) More...
 
virtual const boost::shared_ptr< const msdata::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 ~ChromatogramList ()
 

Private Member Functions

 ChromatogramList_Filter (ChromatogramList_Filter &)
 
ChromatogramList_Filteroperator= (ChromatogramList_Filter &)
 

Private Attributes

boost::shared_ptr< Impl > impl_
 

Additional Inherited Members

- Static Public Member Functions inherited from pwiz::analysis::ChromatogramListWrapper
static bool accept (const msdata::ChromatogramListPtr &inner)
 
- Protected Attributes inherited from pwiz::analysis::ChromatogramListWrapper
msdata::ChromatogramListPtr inner_
 
msdata::DataProcessingPtr dp_
 

Detailed Description

ChromatogramList filter, for creating Chromatogram sub-lists.

Definition at line 41 of file ChromatogramList_Filter.hpp.

Constructor & Destructor Documentation

◆ ChromatogramList_Filter() [1/2]

pwiz::analysis::ChromatogramList_Filter::ChromatogramList_Filter ( const msdata::ChromatogramListPtr  original,
const Predicate predicate 
)

◆ ChromatogramList_Filter() [2/2]

pwiz::analysis::ChromatogramList_Filter::ChromatogramList_Filter ( ChromatogramList_Filter )
private

Member Function Documentation

◆ size()

virtual size_t pwiz::analysis::ChromatogramList_Filter::size ( ) const
virtual

returns the number of chromatograms

Reimplemented from pwiz::analysis::ChromatogramListWrapper.

Referenced by testEven(), testIndexSet(), and testSelectedIndices().

◆ chromatogramIdentity()

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

access to a chromatogram index

Reimplemented from pwiz::analysis::ChromatogramListWrapper.

Referenced by testEven(), testIndexSet(), and testSelectedIndices().

◆ chromatogram()

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

retrieve a chromatogram by index

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

Reimplemented from pwiz::analysis::ChromatogramListWrapper.

◆ operator=()

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

Member Data Documentation

◆ impl_

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

Definition at line 82 of file ChromatogramList_Filter.hpp.


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