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

Public Member Functions

 HasBinaryDataPredicate (DetailLevel suggestedDetailLevel)
 
virtual 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 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 tribool accept (const Spectrum &spectrum) const
 return true iff Spectrum is accepted More...
 
virtual string describe () const
 return a string describing how the predicate filters More...
 
- Public Member Functions inherited from pwiz::analysis::SpectrumList_Filter::Predicate
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 ~Predicate ()
 

Public Attributes

DetailLevel detailLevel_
 

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 298 of file SpectrumList_FilterTest.cpp.

Constructor & Destructor Documentation

◆ HasBinaryDataPredicate()

HasBinaryDataPredicate::HasBinaryDataPredicate ( DetailLevel  suggestedDetailLevel)
inline

Definition at line 300 of file SpectrumList_FilterTest.cpp.

Member Function Documentation

◆ suggestedDetailLevel()

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

Definition at line 303 of file SpectrumList_FilterTest.cpp.

303 {return detailLevel_;}

◆ accept() [1/2]

virtual tribool HasBinaryDataPredicate::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 305 of file SpectrumList_FilterTest.cpp.

306  {
307  return boost::logic::indeterminate;
308  }

◆ accept() [2/2]

virtual tribool HasBinaryDataPredicate::accept ( const Spectrum spectrum) const
inlinevirtual

return true iff Spectrum is accepted

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

Definition at line 310 of file SpectrumList_FilterTest.cpp.

311  {
312  if (spectrum.binaryDataArrayPtrs.empty())
313  return boost::logic::indeterminate;
314  return !spectrum.binaryDataArrayPtrs[0]->data.empty();
315  }

References pwiz::msdata::Spectrum::binaryDataArrayPtrs.

◆ describe()

virtual string HasBinaryDataPredicate::describe ( ) const
inlinevirtual

return a string describing how the predicate filters

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

Definition at line 317 of file SpectrumList_FilterTest.cpp.

317 { return ""; }

Member Data Documentation

◆ detailLevel_

DetailLevel HasBinaryDataPredicate::detailLevel_

Definition at line 302 of file SpectrumList_FilterTest.cpp.


The documentation for this struct was generated from the following file:
HasBinaryDataPredicate::suggestedDetailLevel
virtual DetailLevel suggestedDetailLevel() const
can be overridden in subclasses that know they will need a certain detail level; it must be overridde...
Definition: SpectrumList_FilterTest.cpp:303
pwiz::msdata::Spectrum::binaryDataArrayPtrs
std::vector< BinaryDataArrayPtr > binaryDataArrayPtrs
list of binary data arrays.
Definition: MSData.hpp:526
HasBinaryDataPredicate::detailLevel_
DetailLevel detailLevel_
Definition: SpectrumList_FilterTest.cpp:302