MSData object plus file I/O. More...

Inheritance diagram for pwiz::msdata::MSDataFile:

Classes
struct	WriteConfig
	configuration for write() More...

Public Member Functions
	MSDataFile (const std::string &filename, const Reader *reader=0, bool calculateSourceFileChecksum=false)
	constructs MSData object backed by file; reader==0 -> use DefaultReaderList
void	write (const std::string &filename, const WriteConfig &config=WriteConfig(), const pwiz::util::IterationListenerRegistry *iterationListenerRegistry=0)
	member write function
void	write (std::ostream &os, const WriteConfig &config=WriteConfig(), const pwiz::util::IterationListenerRegistry *iterationListenerRegistry=0)
	member write function
Public Member Functions inherited from pwiz::msdata::MSData
std::vector< DataProcessingPtr >	allDataProcessingPtrs () const
	return dataProcessingPtrs augmented by the dataProcessingPtr() set in SpectrumList and/or ChromatogramList
	MSData ()
virtual	~MSData ()
bool	empty () const
const std::string &	version () const
	returns the version of this mzML document; for a document created programmatically, the version is the current release version of mzML; for a document created from a file/stream, the version is the schema version read from the file/stream

Static Public Member Functions
static void	write (const MSData &msd, const std::string &filename, const WriteConfig &config=WriteConfig(), const pwiz::util::IterationListenerRegistry *iterationListenerRegistry=0)
	static write function for any MSData object; iterationListenerRegistry may be used for progress updates
static void	write (const MSData &msd, std::ostream &os, const WriteConfig &config=WriteConfig(), const pwiz::util::IterationListenerRegistry *iterationListenerRegistry=0)
	static write function for any MSData object; iterationListenerRegistry may be used for progress updates

Additional Inherited Members
Public Attributes inherited from pwiz::msdata::MSData
std::string	accession
	an optional accession number for the mzML document.
std::string	id
	an optional id for the mzML document. It is recommended to use LSIDs when possible.
std::vector< CV >	cvs
	container for one or more controlled vocabulary definitions.
FileDescription	fileDescription
	information pertaining to the entire mzML file (i.e. not specific to any part of the data set) is stored here.
std::vector< ParamGroupPtr >	paramGroupPtrs
	container for a list of referenceableParamGroups
std::vector< SamplePtr >	samplePtrs
	list and descriptions of samples.
std::vector< SoftwarePtr >	softwarePtrs
	list and descriptions of software used to acquire and/or process the data in this mzML file.
std::vector< ScanSettingsPtr >	scanSettingsPtrs
	list with the descriptions of the acquisition settings applied prior to the start of data acquisition.
std::vector < InstrumentConfigurationPtr >	instrumentConfigurationPtrs
	list and descriptions of instrument configurations.
std::vector< DataProcessingPtr >	dataProcessingPtrs
	list and descriptions of data processing applied to this data.
Run	run
	a run in mzML should correspond to a single, consecutive and coherent set of scans on an instrument.
Protected Attributes inherited from pwiz::msdata::MSData
std::string	version_

Detailed Description

MSData object plus file I/O.

Definition at line 40 of file MSDataFile.hpp.

Constructor & Destructor Documentation

pwiz::msdata::MSDataFile::MSDataFile	(	const std::string &	filename,
		const Reader *	reader = `0`,
		bool	calculateSourceFileChecksum = `false`
	)

constructs MSData object backed by file; reader==0 -> use DefaultReaderList

static void pwiz::msdata::MSDataFile::write	(	const MSData &	msd,
		const std::string &	filename,
		const WriteConfig &	config = `WriteConfig()`,
		const pwiz::util::IterationListenerRegistry *	iterationListenerRegistry = `0`
	)

static

static write function for any MSData object; iterationListenerRegistry may be used for progress updates

void pwiz::msdata::MSDataFile::write	(	const std::string &	filename,
		const WriteConfig &	config = `WriteConfig()`,
		const pwiz::util::IterationListenerRegistry *	iterationListenerRegistry = `0`
	)

member write function

static void pwiz::msdata::MSDataFile::write	(	const MSData &	msd,
		std::ostream &	os,
		const WriteConfig &	config = `WriteConfig()`,
		const pwiz::util::IterationListenerRegistry *	iterationListenerRegistry = `0`
	)

static

static write function for any MSData object; iterationListenerRegistry may be used for progress updates

void pwiz::msdata::MSDataFile::write	(	std::ostream &	os,
		const WriteConfig &	config = `WriteConfig()`,
		const pwiz::util::IterationListenerRegistry *	iterationListenerRegistry = `0`
	)

member write function

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