pwiz_RAMPAdapter Class Reference

SWIG-friendly wrapper to provide RAMP-friendly access to MSData library. More...

#include <pwiz_RAMPAdapter.hpp>

List of all members.

Public Member Functions
	pwiz_RAMPAdapter (const std::string &filename)
	constructor
	~pwiz_RAMPAdapter ()
	destructor
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
void	getScanHeader (size_t index, ScanHeaderStruct &result) 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 Attributes
class pwiz::msdata::RAMPAdapter *	m_guts

---

Detailed Description

SWIG-friendly wrapper to provide RAMP-friendly access to MSData library.

Definition at line 33 of file pwiz_RAMPAdapter.hpp.

---

Constructor & Destructor Documentation

pwiz_RAMPAdapter::pwiz_RAMPAdapter

(

const std::string &

filename

)

constructor

pwiz_RAMPAdapter::~pwiz_RAMPAdapter

(

)

destructor

---

Member Function Documentation

size_t pwiz_RAMPAdapter::scanCount

(

)

const

returns the number of scans stored in the data file

size_t pwiz_RAMPAdapter::index

(

int

scanNumber

)

const

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

void pwiz_RAMPAdapter::getScanHeader	(	size_t	index,
		ScanHeaderStruct &	result
	)		const

fills in RAMP ScanHeaderStruct for a specified scan

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

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

void pwiz_RAMPAdapter::getRunHeader

(

RunHeaderStruct &

result

)

const

fills in RAMP RunHeaderStruct

void pwiz_RAMPAdapter::getInstrument

(

InstrumentStruct &

result

)

const

fills in RAMP InstrumentHeaderStruct

---

Member Data Documentation

class pwiz::msdata::RAMPAdapter* pwiz_RAMPAdapter::m_guts

private

Definition at line 67 of file pwiz_RAMPAdapter.hpp.

---

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

• /Users/parag/_Research/pwiz/svn/trunk/pwiz/pwiz/utility/bindings/SWIG/pwiz_RAMPAdapter.hpp