#include <DefaultReaderList.hpp>

Inheritance diagram for pwiz::msdata::Reader_mzML:

Public Member Functions
virtual std::string	identify (const std::string &filename, const std::string &head) const
	return file type iff Reader recognizes the file, else empty;
virtual void	read (const std::string &filename, const std::string &head, MSData &result, int runIndex=0, const Config &config=Config()) const
	fill in the MSData structure from the first (or only) sample
virtual void	read (const std::string &filename, const std::string &head, std::vector< MSDataPtr > &results, const Config &config=Config()) const
	fill in a vector of MSData structures; provides support for multi-run input files
virtual const char *	getType () const
	returns a unique string identifying the reader type
Public Member Functions inherited from pwiz::msdata::Reader
bool	accept (const std::string &filename, const std::string &head) const
	return true iff Reader recognizes the file as one it should handle
virtual void	readIds (const std::string &filename, const std::string &head, std::vector< std::string > &dataIds, const Config &config=Config()) const
	fill in a vector of MSData.Id values; provides support for multi-run input files
virtual	~Reader ()

Private Types
enum	Type { Type_mzML, Type_mzML_Indexed, Type_Unknown }

Private Member Functions
Type	type (std::istream &is) const

Detailed Description

Definition at line 36 of file DefaultReaderList.hpp.

Member Enumeration Documentation

enum pwiz::msdata::Reader_mzML::Type

private

Enumerator:

Type_mzML
Type_mzML_Indexed
Type_Unknown

Definition at line 45 of file DefaultReaderList.hpp.

{ Type_mzML, Type_mzML_Indexed, Type_Unknown };

Member Function Documentation

virtual std::string pwiz::msdata::Reader_mzML::identify	(	const std::string &	filename,
		const std::string &	head
	)		const

virtual

return file type iff Reader recognizes the file, else empty;

note: for formats requiring a 3rd party DLL identify() should return non-empty if it recognized the format, even though reading may fail if the 3rd party DLL isn't actually present Reader may filter based on filename and/or head of the file

Implements pwiz::msdata::Reader.

virtual void pwiz::msdata::Reader_mzML::read	(	const std::string &	filename,
		const std::string &	head,
		MSData &	result,
		int	runIndex = `0`,
		const Config &	config = `Config()`
	)		const

virtual

fill in the MSData structure from the first (or only) sample

Implements pwiz::msdata::Reader.

virtual void pwiz::msdata::Reader_mzML::read	(	const std::string &	filename,
		const std::string &	head,
		std::vector< MSDataPtr > &	results,
		const Config &	config = `Config()`
	)		const