ProteoWizard
Public Member Functions | Static Public Member Functions | Protected Attributes
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_SavitzkyGolaySmoother

List of all members.

Public Member Functions

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

Static Public Member Functions

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

Protected Attributes

msdata::ChromatogramListPtr inner_

Detailed Description

Inheritable pass-through implementation for wrapping a ChromatogramList.

Definition at line 38 of file ChromatogramListWrapper.hpp.


Constructor & Destructor Documentation

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

Definition at line 42 of file ChromatogramListWrapper.hpp.

: inner_(inner)
{
if (!inner.get()) throw std::runtime_error("[ChromatogramListWrapper] Null ChromatogramListPtr.");
}

Member Function Documentation

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

Reimplemented in pwiz::analysis::ChromatogramList_SavitzkyGolaySmoother.

Definition at line 48 of file ChromatogramListWrapper.hpp.

{return true;}
virtual size_t pwiz::analysis::ChromatogramListWrapper::size ( ) const
inlinevirtual

returns the number of chromatograms

Implements pwiz::msdata::ChromatogramList.

Definition at line 50 of file ChromatogramListWrapper.hpp.

{return inner_->size();}
virtual bool pwiz::analysis::ChromatogramListWrapper::empty ( ) const
inlinevirtual

returns true iff (size() == 0) and (dataProcessingPtr.get() == NULL)

Reimplemented from pwiz::msdata::ChromatogramList.

Definition at line 51 of file ChromatogramListWrapper.hpp.

{return inner_->empty();}
virtual const msdata::ChromatogramIdentity& pwiz::analysis::ChromatogramListWrapper::chromatogramIdentity ( size_t  index) const
inlinevirtual

access to a chromatogram index

Implements pwiz::msdata::ChromatogramList.

Definition at line 52 of file ChromatogramListWrapper.hpp.

{return inner_->chromatogramIdentity(index);}
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 53 of file ChromatogramListWrapper.hpp.

{return inner_->find(id);}
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.

Definition at line 54 of file ChromatogramListWrapper.hpp.

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

Member Data Documentation

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

Definition at line 58 of file ChromatogramListWrapper.hpp.


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