ProteoWizard
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
pwiz::analysis::ChromatogramListWrapper Class Reference

Inheritable pass-through implementation for wrapping a ChromatogramList. More...

#include <ChromatogramListWrapper.hpp>

Inheritance diagram for pwiz::analysis::ChromatogramListWrapper:
pwiz::msdata::ChromatogramList pwiz::analysis::ChromatogramList_Filter pwiz::analysis::ChromatogramList_LockmassRefiner pwiz::analysis::ChromatogramList_SavitzkyGolaySmoother pwiz::analysis::ChromatogramList_XICGenerator

Public Member Functions

 ChromatogramListWrapper (const msdata::ChromatogramListPtr &inner)
 
virtual size_t size () const
 returns the number of chromatograms More...
 
virtual bool empty () const
 
virtual const msdata::ChromatogramIdentitychromatogramIdentity (size_t index) const
 access to a chromatogram index More...
 
virtual size_t find (const std::string &id) const
 find id in the chromatogram index (returns size() on failure) More...
 
virtual msdata::ChromatogramPtr chromatogram (size_t index, bool getBinaryData=false) const
 retrieve a chromatogram by index More...
 
virtual const boost::shared_ptr< const msdata::DataProcessingdataProcessingPtr () const
 returns the data processing affecting spectra retrieved through this interface More...
 
- Public Member Functions inherited from pwiz::msdata::ChromatogramList
bool empty () const
 returns true iff (size() == 0) and (dataProcessingPtr.get() == NULL) More...
 
virtual ~ChromatogramList ()
 

Static Public Member Functions

static bool accept (const msdata::ChromatogramListPtr &inner)
 

Protected Attributes

msdata::ChromatogramListPtr inner_
 
msdata::DataProcessingPtr dp_
 

Detailed Description

Inheritable pass-through implementation for wrapping a ChromatogramList.

Definition at line 38 of file ChromatogramListWrapper.hpp.

Constructor & Destructor Documentation

◆ ChromatogramListWrapper()

pwiz::analysis::ChromatogramListWrapper::ChromatogramListWrapper ( const msdata::ChromatogramListPtr inner)
inline

Definition at line 42 of file ChromatogramListWrapper.hpp.

43  : inner_(inner),
44  dp_(inner->dataProcessingPtr().get() ? new msdata::DataProcessing(*inner->dataProcessingPtr())
45  : new msdata::DataProcessing("pwiz_Chromatogram_Processing"))
46  {
47  if (!inner.get()) throw std::runtime_error("[ChromatogramListWrapper] Null ChromatogramListPtr.");
48  }

Member Function Documentation

◆ accept()

static bool pwiz::analysis::ChromatogramListWrapper::accept ( const msdata::ChromatogramListPtr inner)
inlinestatic

Definition at line 50 of file ChromatogramListWrapper.hpp.

50 {return true;}

◆ size()

virtual size_t pwiz::analysis::ChromatogramListWrapper::size ( ) const
inlinevirtual

returns the number of chromatograms

Implements pwiz::msdata::ChromatogramList.

Reimplemented in pwiz::analysis::ChromatogramList_Filter.

Definition at line 52 of file ChromatogramListWrapper.hpp.

52 {return inner_->size();}

◆ empty()

virtual bool pwiz::analysis::ChromatogramListWrapper::empty ( ) const
inlinevirtual

Definition at line 53 of file ChromatogramListWrapper.hpp.

53 {return inner_->empty();}

◆ chromatogramIdentity()

virtual const msdata::ChromatogramIdentity& pwiz::analysis::ChromatogramListWrapper::chromatogramIdentity ( size_t  index) const
inlinevirtual

access to a chromatogram index

Implements pwiz::msdata::ChromatogramList.

Reimplemented in pwiz::analysis::ChromatogramList_Filter.

Definition at line 54 of file ChromatogramListWrapper.hpp.

54 {return inner_->chromatogramIdentity(index);}

◆ find()

virtual size_t pwiz::analysis::ChromatogramListWrapper::find ( const std::string &  id) const
inlinevirtual

find id in the chromatogram index (returns size() on failure)

Reimplemented from pwiz::msdata::ChromatogramList.

Definition at line 55 of file ChromatogramListWrapper.hpp.

55 {return inner_->find(id);}

◆ chromatogram()

virtual msdata::ChromatogramPtr pwiz::analysis::ChromatogramListWrapper::chromatogram ( size_t  index,
bool  getBinaryData = false 
) const
inlinevirtual

retrieve a chromatogram by index

  • binary data arrays will be provided if (getBinaryData == true);
  • client may assume the underlying Chromatogram* is valid

Implements pwiz::msdata::ChromatogramList.

Reimplemented in pwiz::analysis::ChromatogramList_SavitzkyGolaySmoother, pwiz::analysis::ChromatogramList_LockmassRefiner, and pwiz::analysis::ChromatogramList_Filter.

Definition at line 56 of file ChromatogramListWrapper.hpp.

56 { return inner_->chromatogram(index, getBinaryData); }

◆ dataProcessingPtr()

virtual const boost::shared_ptr<const msdata::DataProcessing> pwiz::analysis::ChromatogramListWrapper::dataProcessingPtr ( ) const
inlinevirtual

returns the data processing affecting spectra retrieved through this interface

  • may return a null shared pointer

Reimplemented from pwiz::msdata::ChromatogramList.

Definition at line 58 of file ChromatogramListWrapper.hpp.

58 { return dp_; }

Member Data Documentation

◆ inner_

msdata::ChromatogramListPtr pwiz::analysis::ChromatogramListWrapper::inner_
protected

Definition at line 62 of file ChromatogramListWrapper.hpp.

◆ dp_

msdata::DataProcessingPtr pwiz::analysis::ChromatogramListWrapper::dp_
protected

Definition at line 63 of file ChromatogramListWrapper.hpp.


The documentation for this class was generated from the following file:
pwiz::analysis::ChromatogramListWrapper::inner_
msdata::ChromatogramListPtr inner_
Definition: ChromatogramListWrapper.hpp:62
pwiz::analysis::ChromatogramListWrapper::dp_
msdata::DataProcessingPtr dp_
Definition: ChromatogramListWrapper.hpp:63