ProteoWizard
Public Member Functions | List of all members
pwiz::analysis::ChromatogramList_Filter::Predicate Struct Referenceabstract

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

#include <ChromatogramList_Filter.hpp>

Inheritance diagram for pwiz::analysis::ChromatogramList_Filter::Predicate:
EvenPredicate pwiz::analysis::ChromatogramList_FilterPredicate_IndexSet SelectedIndexPredicate

Public Member Functions

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 More...
 
virtual boost::logic::tribool accept (const msdata::ChromatogramIdentity &chromatogramIdentity) const =0
 return values: true: accept the Chromatogram false: reject the Chromatogram indeterminate: need to see the full Chromatogram object to decide More...
 
virtual boost::logic::tribool accept (const msdata::Chromatogram &chromatogram) const
 return true iff Chromatogram is accepted More...
 
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. More...
 
virtual ~Predicate ()
 

Detailed Description

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

Definition at line 47 of file ChromatogramList_Filter.hpp.

Constructor & Destructor Documentation

◆ ~Predicate()

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

Definition at line 69 of file ChromatogramList_Filter.hpp.

69 {}

Member Function Documentation

◆ suggestedDetailLevel()

virtual bool pwiz::analysis::ChromatogramList_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

Definition at line 51 of file ChromatogramList_Filter.hpp.

51 {return false;}

◆ accept() [1/2]

virtual boost::logic::tribool pwiz::analysis::ChromatogramList_Filter::Predicate::accept ( const msdata::ChromatogramIdentity chromatogramIdentity) const
pure virtual

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

Implemented in pwiz::analysis::ChromatogramList_FilterPredicate_IndexSet, SelectedIndexPredicate, and EvenPredicate.

◆ accept() [2/2]

virtual boost::logic::tribool pwiz::analysis::ChromatogramList_Filter::Predicate::accept ( const msdata::Chromatogram chromatogram) const
inlinevirtual

return true iff Chromatogram is accepted

Definition at line 60 of file ChromatogramList_Filter.hpp.

60 {return false;}

◆ done()

virtual bool pwiz::analysis::ChromatogramList_Filter::Predicate::done ( ) const
inlinevirtual

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.

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

Reimplemented in SelectedIndexPredicate, SelectedIndexPredicate, pwiz::analysis::ChromatogramList_FilterPredicate_IndexSet, and SelectedIndexPredicate.

Definition at line 67 of file ChromatogramList_Filter.hpp.

67 {return false;}

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