ProteoWizard
Public Member Functions | List of all members
EvenPredicate Struct Reference
Inheritance diagram for EvenPredicate:
pwiz::analysis::ChromatogramList_Filter::Predicate pwiz::analysis::SpectrumList_Filter::Predicate

Public Member Functions

virtual tribool accept (const ChromatogramIdentity &chromatogramIdentity) const
 return values: true: accept the Chromatogram false: reject the Chromatogram indeterminate: need to see the full Chromatogram object to decide
 
virtual tribool accept (const SpectrumIdentity &spectrumIdentity) const
 return values: true: accept the Spectrum false: reject the Spectrum indeterminate: need to see the full Spectrum object to decide
 
virtual string describe () const
 return a string describing how the predicate filters
 
- Public Member Functions inherited from pwiz::analysis::ChromatogramList_Filter::Predicate
virtual bool 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::Chromatogram &chromatogram) const
 return true iff Chromatogram is accepted
 
virtual bool done () const
 return true iff done accepting chromatograms; this allows early termination of the iteration through the original ChromatogramList, possibly using assumptions about the order of the iteration (e.g.
 
virtual ~Predicate ()
 
- Public Member Functions inherited from pwiz::analysis::SpectrumList_Filter::Predicate
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::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 ()
 

Additional Inherited Members

- Public Types inherited from pwiz::analysis::SpectrumList_Filter::Predicate
enum  FilterMode { FilterMode_Include , FilterMode_Exclude }
 controls whether spectra that pass the predicate are included or excluded from the result More...
 

Detailed Description

Definition at line 109 of file ChromatogramList_FilterTest.cpp.

Member Function Documentation

◆ accept() [1/2]

virtual tribool EvenPredicate::accept ( const ChromatogramIdentity chromatogramIdentity) const
inlinevirtual

return values: true: accept the Chromatogram false: reject the Chromatogram indeterminate: need to see the full Chromatogram object to decide

Implements pwiz::analysis::ChromatogramList_Filter::Predicate.

Definition at line 111 of file ChromatogramList_FilterTest.cpp.

112 {
113 return chromatogramIdentity.index%2 == 0;
114 }
size_t index
the zero-based, consecutive index of the chromatogram in the ChromatogramList.
Definition MSData.hpp:492

References pwiz::msdata::ChromatogramIdentity::index.

◆ accept() [2/2]

virtual tribool EvenPredicate::accept ( const SpectrumIdentity spectrumIdentity) const
inlinevirtual

return values: true: accept the Spectrum false: reject the Spectrum indeterminate: need to see the full Spectrum object to decide

Implements pwiz::analysis::SpectrumList_Filter::Predicate.

Definition at line 175 of file SpectrumList_FilterTest.cpp.

176 {
177 return spectrumIdentity.index%2 == 0;
178 }
size_t index
the zero-based, consecutive index of the spectrum in the SpectrumList.
Definition MSData.hpp:473

References pwiz::msdata::SpectrumIdentity::index.

◆ describe()

virtual string EvenPredicate::describe ( ) const
inlinevirtual

return a string describing how the predicate filters

Implements pwiz::analysis::SpectrumList_Filter::Predicate.

Definition at line 180 of file SpectrumList_FilterTest.cpp.

180{ return ""; }

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