ProteoWizard
Public Member Functions | Private Member Functions | Private Attributes
pwiz::msdata::RAMPAdapter Class Reference

adapter to provide RAMP-friendly access to MSData library More...

#include <RAMPAdapter.hpp>

List of all members.

Public Member Functions

 RAMPAdapter (const std::string &filename)
 constructor
size_t scanCount () const
 returns the number of scans stored in the data file
size_t index (int scanNumber) const
 converts a scan number to a 0-based index; returns scanCount() if scanNumber is not found
int getScanNumber (size_t index) const
 returns the scan number for a specified scan
void getScanHeader (size_t index, ScanHeaderStruct &result, bool reservePeaks=false) const
 fills in RAMP ScanHeaderStruct for a specified scan
void getScanPeaks (size_t index, std::vector< double > &result) const
 fills in m/z-intensity pair array for a specified scan
void getRunHeader (RunHeaderStruct &result) const
 fills in RAMP RunHeaderStruct
void getInstrument (InstrumentStruct &result) const
 fills in RAMP InstrumentHeaderStruct

Private Member Functions

 RAMPAdapter (RAMPAdapter &that)
RAMPAdapteroperator= (RAMPAdapter &that)

Private Attributes

boost::shared_ptr< Impl > impl_

Detailed Description

adapter to provide RAMP-friendly access to MSData library

Definition at line 40 of file RAMPAdapter.hpp.


Constructor & Destructor Documentation

pwiz::msdata::RAMPAdapter::RAMPAdapter ( const std::string &  filename)

constructor

pwiz::msdata::RAMPAdapter::RAMPAdapter ( RAMPAdapter that)
private

Member Function Documentation

size_t pwiz::msdata::RAMPAdapter::scanCount ( ) const

returns the number of scans stored in the data file

Referenced by test(), and test_mzML_1_0().

size_t pwiz::msdata::RAMPAdapter::index ( int  scanNumber) const

converts a scan number to a 0-based index; returns scanCount() if scanNumber is not found

Referenced by test().

int pwiz::msdata::RAMPAdapter::getScanNumber ( size_t  index) const

returns the scan number for a specified scan

void pwiz::msdata::RAMPAdapter::getScanHeader ( size_t  index,
ScanHeaderStruct result,
bool  reservePeaks = false 
) const

fills in RAMP ScanHeaderStruct for a specified scan

you can optionally preload the peaklists too, but the RAMP interface this emulates doesn't normally do that, so defaulting reservePeaks to true would be a nasty surprise performance-wise to anyone switching over from actual RAMP

Referenced by test(), and test_mzML_1_0().

void pwiz::msdata::RAMPAdapter::getScanPeaks ( size_t  index,
std::vector< double > &  result 
) const

fills in m/z-intensity pair array for a specified scan

Referenced by test().

void pwiz::msdata::RAMPAdapter::getRunHeader ( RunHeaderStruct result) const

fills in RAMP RunHeaderStruct

Referenced by test().

void pwiz::msdata::RAMPAdapter::getInstrument ( InstrumentStruct result) const

fills in RAMP InstrumentHeaderStruct

Referenced by test().

RAMPAdapter& pwiz::msdata::RAMPAdapter::operator= ( RAMPAdapter that)
private

Member Data Documentation

boost::shared_ptr<Impl> pwiz::msdata::RAMPAdapter::impl_
private

Definition at line 75 of file RAMPAdapter.hpp.


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