ProteoWizard
Public Member Functions
pwiz::analysis::SpectrumList_Filter::Predicate Struct Reference

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

#include <SpectrumList_Filter.hpp>

Inheritance diagram for pwiz::analysis::SpectrumList_Filter::Predicate:
EvenMS2Predicate EvenPredicate HasBinaryDataPredicate pwiz::analysis::SpectrumList_FilterPredicate_ActivationType pwiz::analysis::SpectrumList_FilterPredicate_AnalyzerType pwiz::analysis::SpectrumList_FilterPredicate_DefaultArrayLengthSet pwiz::analysis::SpectrumList_FilterPredicate_IndexSet pwiz::analysis::SpectrumList_FilterPredicate_MSLevelSet pwiz::analysis::SpectrumList_FilterPredicate_Polarity pwiz::analysis::SpectrumList_FilterPredicate_PrecursorMzSet pwiz::analysis::SpectrumList_FilterPredicate_ScanEventSet pwiz::analysis::SpectrumList_FilterPredicate_ScanNumberSet pwiz::analysis::SpectrumList_FilterPredicate_ScanTimeRange SelectedIndexPredicate

List of all members.

Public Member Functions

virtual msdata::DetailLevel suggestedDetailLevel () const
 can be overridden in subclasses that know they will need a certain detail level; it must be overridden to return DetailLevel_FullData if binary data is needed
virtual boost::logic::tribool accept (const msdata::SpectrumIdentity &spectrumIdentity) const =0
 return values: true: accept the Spectrum false: reject the Spectrum indeterminate: need to see the full Spectrum object to decide
virtual boost::logic::tribool accept (const msdata::Spectrum &spectrum) const
 return true iff Spectrum is accepted
virtual bool done () const
 return true iff done accepting spectra; this allows early termination of the iteration through the original SpectrumList, possibly using assumptions about the order of the iteration (e.g.
virtual ~Predicate ()

Detailed Description

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

Definition at line 46 of file SpectrumList_Filter.hpp.


Constructor & Destructor Documentation

virtual pwiz::analysis::SpectrumList_Filter::Predicate::~Predicate ( )
inlinevirtual

Definition at line 68 of file SpectrumList_Filter.hpp.

{}

Member Function Documentation

virtual msdata::DetailLevel pwiz::analysis::SpectrumList_Filter::Predicate::suggestedDetailLevel ( ) const
inlinevirtual

can be overridden in subclasses that know they will need a certain detail level; it must be overridden to return DetailLevel_FullData if binary data is needed

Reimplemented in HasBinaryDataPredicate.

Definition at line 50 of file SpectrumList_Filter.hpp.

References pwiz::msdata::DetailLevel_InstantMetadata.

virtual boost::logic::tribool pwiz::analysis::SpectrumList_Filter::Predicate::accept ( const msdata::SpectrumIdentity spectrumIdentity) const
pure virtual
virtual boost::logic::tribool pwiz::analysis::SpectrumList_Filter::Predicate::accept ( const msdata::Spectrum spectrum) const
inlinevirtual
virtual bool pwiz::analysis::SpectrumList_Filter::Predicate::done ( ) const
inlinevirtual

return true iff done accepting spectra; this allows early termination of the iteration through the original SpectrumList, possibly using assumptions about the order of the iteration (e.g.

index is increasing, nativeID interpreted as scan number is increasing, ...)

Reimplemented in SelectedIndexPredicate, pwiz::analysis::SpectrumList_FilterPredicate_ScanNumberSet, pwiz::analysis::SpectrumList_FilterPredicate_IndexSet, and SelectedIndexPredicate.

Definition at line 66 of file SpectrumList_Filter.hpp.

{return false;}

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