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

#include <SpectrumList_Filter.hpp>

Inheritance diagram for pwiz::analysis::SpectrumList_FilterPredicate_Polarity:
pwiz::analysis::SpectrumList_Filter::Predicate

Public Member Functions

 SpectrumList_FilterPredicate_Polarity (pwiz::cv::CVID polarity)
 
virtual boost::logic::tribool accept (const msdata::SpectrumIdentity &spectrumIdentity) const
 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 std::string describe () const
 return a string describing how the predicate filters
 
- 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 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 ()
 

Private Attributes

pwiz::cv::CVID polarity
 

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 266 of file SpectrumList_Filter.hpp.

Constructor & Destructor Documentation

◆ SpectrumList_FilterPredicate_Polarity()

pwiz::analysis::SpectrumList_FilterPredicate_Polarity::SpectrumList_FilterPredicate_Polarity ( pwiz::cv::CVID  polarity)

Member Function Documentation

◆ accept() [1/2]

virtual boost::logic::tribool pwiz::analysis::SpectrumList_FilterPredicate_Polarity::accept ( const msdata::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 270 of file SpectrumList_Filter.hpp.

270{return boost::logic::indeterminate;}

◆ accept() [2/2]

virtual boost::logic::tribool pwiz::analysis::SpectrumList_FilterPredicate_Polarity::accept ( const msdata::Spectrum spectrum) const
virtual

return true iff Spectrum is accepted

Reimplemented from pwiz::analysis::SpectrumList_Filter::Predicate.

◆ describe()

virtual std::string pwiz::analysis::SpectrumList_FilterPredicate_Polarity::describe ( ) const
inlinevirtual

return a string describing how the predicate filters

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

Definition at line 272 of file SpectrumList_Filter.hpp.

272{ return "polarity"; }

Member Data Documentation

◆ polarity

pwiz::cv::CVID pwiz::analysis::SpectrumList_FilterPredicate_Polarity::polarity
private

Definition at line 275 of file SpectrumList_Filter.hpp.


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