ProteoWizard
Public Member Functions | List of all members
MyBase Class Reference
Inheritance diagram for MyBase:
pwiz::msdata::ChromatogramListBase pwiz::msdata::SpectrumListBase pwiz::msdata::ChromatogramList pwiz::msdata::SpectrumList

Public Member Functions

virtual size_t size () const
 returns the number of chromatograms
 
virtual const ChromatogramIdentitychromatogramIdentity (size_t index) const
 access to a chromatogram index
 
virtual ChromatogramPtr chromatogram (size_t index, bool getBinaryData=false) const
 retrieve a chromatogram by index
 
virtual size_t size () const
 returns the number of chromatograms
 
virtual const SpectrumIdentityspectrumIdentity (size_t index) const
 access to a spectrum index
 
virtual SpectrumPtr spectrum (size_t index, bool getBinaryData=false) const
 retrieve a spectrum by index
 
virtual const boost::shared_ptr< const DataProcessingdataProcessingPtr () const
 implementation of ChromatogramList
 
- Public Member Functions inherited from pwiz::msdata::ChromatogramListBase
virtual void setDataProcessingPtr (DataProcessingPtr dp)
 set DataProcessing
 
const char * polarityStringForFilter (CVID polarityType) const
 
- Public Member Functions inherited from pwiz::msdata::ChromatogramList
bool empty () const
 returns true iff (size() == 0) and (dataProcessingPtr.get() == NULL)
 
virtual size_t find (const std::string &id) const
 find id in the chromatogram index (returns size() on failure)
 
virtual ~ChromatogramList ()
 
- Public Member Functions inherited from pwiz::msdata::SpectrumListBase
 SpectrumListBase ()
 
virtual void setDataProcessingPtr (DataProcessingPtr dp)
 set DataProcessing
 
virtual void warn_once (const char *msg) const
 issues a warning once per SpectrumList instance (based on string hash)
 
- Public Member Functions inherited from pwiz::msdata::SpectrumList
virtual bool empty () const
 returns true iff (size() == 0) and (dataProcessingPtr.get() == NULL)
 
virtual size_t find (const std::string &id) const
 find id in the spectrum index (returns size() on failure)
 
virtual size_t findAbbreviated (const std::string &abbreviatedId, char delimiter='.') const
 find an abbreviated id (e.g. "1.1.123.2" for "sample=1 period=1 cycle=123 experiment=2") in the spectrum index (returns size() on failure)
 
virtual IndexList findNameValue (const std::string &name, const std::string &value) const
 find all spectrum indexes with specified name/value pair
 
virtual IndexList findSpotID (const std::string &spotID) const
 find all spectrum indexes with spotID (returns empty vector on failure)
 
virtual SpectrumPtr spectrum (const SpectrumPtr &seed, bool getBinaryData) const
 get a copy of the seed spectrum, optionally with its binary data populated this is useful for formats like mzML that can delay loading of binary data
 
virtual SpectrumPtr spectrum (size_t index, DetailLevel detailLevel) const
 retrieve a spectrum by index
 
virtual ~SpectrumList ()
 

Additional Inherited Members

- Protected Attributes inherited from pwiz::msdata::ChromatogramListBase
DataProcessingPtr dp_
 
- Protected Attributes inherited from pwiz::msdata::SpectrumListBase
DataProcessingPtr dp_
 
const pwiz::util::IntegerSet MSLevelsNone
 

Detailed Description

Definition at line 32 of file ChromatogramListBaseTest.cpp.

Member Function Documentation

◆ size() [1/2]

virtual size_t MyBase::size ( ) const
inlinevirtual

returns the number of chromatograms

Implements pwiz::msdata::ChromatogramList.

Definition at line 35 of file ChromatogramListBaseTest.cpp.

35{return 0;}

◆ chromatogramIdentity()

virtual const ChromatogramIdentity & MyBase::chromatogramIdentity ( size_t  index) const
inlinevirtual

access to a chromatogram index

Implements pwiz::msdata::ChromatogramList.

Definition at line 36 of file ChromatogramListBaseTest.cpp.

36{throw runtime_error("heh");}

◆ chromatogram()

virtual ChromatogramPtr MyBase::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.

Definition at line 37 of file ChromatogramListBaseTest.cpp.

37{return ChromatogramPtr();}
boost::shared_ptr< Chromatogram > ChromatogramPtr
Definition MSData.hpp:624

◆ size() [2/2]

virtual size_t MyBase::size ( ) const
inlinevirtual

returns the number of chromatograms

Implements pwiz::msdata::ChromatogramList.

Definition at line 35 of file SpectrumListBaseTest.cpp.

35{return 0;}

◆ spectrumIdentity()

virtual const SpectrumIdentity & MyBase::spectrumIdentity ( size_t  index) const
inlinevirtual

access to a spectrum index

Implements pwiz::msdata::SpectrumList.

Definition at line 36 of file SpectrumListBaseTest.cpp.

36{throw runtime_error("heh");}

◆ spectrum()

virtual SpectrumPtr MyBase::spectrum ( size_t  index,
bool  getBinaryData = false 
) const
inlinevirtual

retrieve a spectrum by index

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

Implements pwiz::msdata::SpectrumList.

Definition at line 37 of file SpectrumListBaseTest.cpp.

37{return SpectrumPtr();}
boost::shared_ptr< Spectrum > SpectrumPtr
Definition MSData.hpp:573

◆ dataProcessingPtr()

virtual const boost::shared_ptr< const DataProcessing > MyBase::dataProcessingPtr ( ) const
inlinevirtual

implementation of ChromatogramList

Reimplemented from pwiz::msdata::ChromatogramListBase.

Definition at line 40 of file SpectrumListBaseTest.cpp.

40{return dp_;}

References pwiz::msdata::ChromatogramListBase::dp_.

Referenced by test().


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