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

#include <SpectrumList_Filter.hpp>

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

Public Member Functions

 SpectrumList_FilterPredicate_IdSet (const std::set< std::string > &idSet)
 
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 More...
 
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. More...
 
virtual std::string describe () const
 return a string describing how the predicate filters More...
 
- 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 More...
 
virtual boost::logic::tribool accept (const msdata::Spectrum &spectrum) const
 return true iff Spectrum is accepted More...
 
virtual ~Predicate ()
 

Private Attributes

std::set< std::string > idSet_
 

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

Constructor & Destructor Documentation

◆ SpectrumList_FilterPredicate_IdSet()

pwiz::analysis::SpectrumList_FilterPredicate_IdSet::SpectrumList_FilterPredicate_IdSet ( const std::set< std::string > &  idSet)

Member Function Documentation

◆ accept()

virtual boost::logic::tribool pwiz::analysis::SpectrumList_FilterPredicate_IdSet::accept ( const msdata::SpectrumIdentity spectrumIdentity) const
virtual

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.

◆ done()

virtual bool pwiz::analysis::SpectrumList_FilterPredicate_IdSet::done ( ) const
virtual

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 from pwiz::analysis::SpectrumList_Filter::Predicate.

◆ describe()

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

return a string describing how the predicate filters

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

Definition at line 141 of file SpectrumList_Filter.hpp.

141 { return "set of spectrum ids"; }

Member Data Documentation

◆ idSet_

std::set<std::string> pwiz::analysis::SpectrumList_FilterPredicate_IdSet::idSet_
private

Definition at line 144 of file SpectrumList_Filter.hpp.


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