ProteoWizard
Public Member Functions | Static Public Member Functions
pwiz::msdata::SpectrumList_mz5 Class Reference

implementation of SpectrumList, backed by an mz5 file More...

#include <SpectrumList_mz5.hpp>

Inheritance diagram for pwiz::msdata::SpectrumList_mz5:
pwiz::msdata::SpectrumListBase pwiz::msdata::SpectrumList

List of all members.

Public Member Functions

virtual ~SpectrumList_mz5 ()
 Destructor.
- Public Member Functions inherited from pwiz::msdata::SpectrumListBase
virtual const
boost::shared_ptr< const
DataProcessing
dataProcessingPtr () const
 implementation of SpectrumList
virtual void setDataProcessingPtr (DataProcessingPtr dp)
 set DataProcessing
- Public Member Functions inherited from pwiz::msdata::SpectrumList
virtual size_t size () const =0
 returns the number of spectra
virtual bool empty () const
 returns true iff (size() == 0) and (dataProcessingPtr.get() == NULL)
virtual const SpectrumIdentityspectrumIdentity (size_t index) const =0
 access to a spectrum index
virtual size_t find (const std::string &id) const
 find id 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 (size_t index, bool getBinaryData=false) const =0
 retrieve a spectrum by index
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 ()

Static Public Member Functions

static SpectrumListPtr create (boost::shared_ptr< mz5::ReferenceRead_mz5 > readPtr, boost::shared_ptr< mz5::Connection_mz5 > connectionPtr, const MSData &msd)
 Creates a smart pointer holding the SpectrumList.

Additional Inherited Members

- Protected Attributes inherited from pwiz::msdata::SpectrumListBase
DataProcessingPtr dp_

Detailed Description

implementation of SpectrumList, backed by an mz5 file

Definition at line 41 of file SpectrumList_mz5.hpp.


Constructor & Destructor Documentation

virtual pwiz::msdata::SpectrumList_mz5::~SpectrumList_mz5 ( )
virtual

Destructor.


Member Function Documentation

static SpectrumListPtr pwiz::msdata::SpectrumList_mz5::create ( boost::shared_ptr< mz5::ReferenceRead_mz5 readPtr,
boost::shared_ptr< mz5::Connection_mz5 connectionPtr,
const MSData msd 
)
static

Creates a smart pointer holding the SpectrumList.

Parameters:
readPtrHelper object to read mz5 files
connectionPtrconnection to mz5 file
msdMSData object

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