MzTabMFile Class Reference

File adapter for MzTab-M files. More...

#include <OpenMS/FORMAT/MzTabMFile.h>

Public Member Functions
	MzTabMFile ()
	Default Constructor.
	~MzTabMFile ()
	Default Destructor.
void	store (const std::string &filename, const MzTabM &mztab_m) const
	Store MzTabM file.

Protected Member Functions
void	generateMzTabMMetaDataSection_ (const MzTabMMetaData &map, StringList &sl) const
	Generates the MzTabM MetaData Section.
std::string	generateMzTabMSmallMoleculeHeader_ (const MzTabMMetaData &meta, const std::vector< std::string > &optional_columns, size_t &n_columns) const
	Generates the MzTabM Small Molecule Header.
std::string	generateMzTabMSmallMoleculeSectionRow_ (const MzTabMSmallMoleculeSectionRow &row, const std::vector< std::string > &optional_columns, size_t &n_columns) const
	Generates the MzTabM Small Molecule Section.
std::string	generateMzTabMSmallMoleculeFeatureHeader_ (const MzTabMMetaData &meta, const std::vector< std::string > &optional_columns, size_t &n_columns) const
	Generates the MzTabM Small Molecule Header.
std::string	generateMzTabMSmallMoleculeFeatureSectionRow_ (const MzTabMSmallMoleculeFeatureSectionRow &row, const std::vector< std::string > &optional_columns, size_t &n_columns) const
	Generates the MzTabM Small Molecule Feature Section.
std::string	generateMzTabMSmallMoleculeEvidenceHeader_ (const MzTabMMetaData &meta, const std::vector< std::string > &optional_columns, size_t &n_columns) const
	Generates the MzTabM Small Molecule Header.
std::string	generateMzTabMSmallMoleculeEvidenceSectionRow_ (const MzTabMSmallMoleculeEvidenceSectionRow &row, const std::vector< std::string > &optional_columns, size_t &n_columns) const
	Generates the MzTabM Small Molecule Evidence Section.

Detailed Description

File adapter for MzTab-M files.

Constructor & Destructor Documentation

MzTabMFile()

MzTabMFile

(

)

Default Constructor.

~MzTabMFile()

~MzTabMFile

(

)

Default Destructor.

Member Function Documentation

generateMzTabMMetaDataSection_()

void generateMzTabMMetaDataSection_ ( const MzTabMMetaData &  map, StringList &  sl  ) const

protected

Generates the MzTabM MetaData Section.

Parameters

[in]	map	MzTabMMetaData
[out]	sl	Fill Stringlist with MztabM MetaData entries

generateMzTabMSmallMoleculeEvidenceHeader_()

std::string generateMzTabMSmallMoleculeEvidenceHeader_ ( const MzTabMMetaData &  meta, const std::vector< std::string > &  optional_columns, size_t &  n_columns  ) const

protected

Generates the MzTabM Small Molecule Header.

Parameters

[in]	meta	MzTabMMetaData
[in]	optional_columns	Add optional columns
[out]	n_columns	Stores the number of columns in the header

Returns

StringList with SEH entries

generateMzTabMSmallMoleculeEvidenceSectionRow_()

std::string generateMzTabMSmallMoleculeEvidenceSectionRow_ ( const MzTabMSmallMoleculeEvidenceSectionRow &  row, const std::vector< std::string > &  optional_columns, size_t &  n_columns  ) const

protected

Generates the MzTabM Small Molecule Evidence Section.

Parameters

[in]	row	MzTabMSmallMoleculeFeatureSectionRow
[in]	optional_columns	Add optional columns
[out]	n_columns	Stores the number of columns per row

Returns

StringList with SME entries

generateMzTabMSmallMoleculeFeatureHeader_()

std::string generateMzTabMSmallMoleculeFeatureHeader_ ( const MzTabMMetaData &  meta, const std::vector< std::string > &  optional_columns, size_t &  n_columns  ) const

protected

Generates the MzTabM Small Molecule Header.

Parameters

[in]	meta	MzTabMMetaData
[in]	optional_columns	Add optional columns
[out]	n_columns	Stores the number of columns in the header

Returns

StringList with SFH entries

generateMzTabMSmallMoleculeFeatureSectionRow_()

std::string generateMzTabMSmallMoleculeFeatureSectionRow_ ( const MzTabMSmallMoleculeFeatureSectionRow &  row, const std::vector< std::string > &  optional_columns, size_t &  n_columns  ) const

protected

Generates the MzTabM Small Molecule Feature Section.

Parameters

[in]	row	MzTabMSmallMoleculeFeatureSectionRow
[in]	optional_columns	Add optional columns
[out]	n_columns	Stores the number of columns per row

Returns

StringList with SMF entries

generateMzTabMSmallMoleculeHeader_()

std::string generateMzTabMSmallMoleculeHeader_ ( const MzTabMMetaData &  meta, const std::vector< std::string > &  optional_columns, size_t &  n_columns  ) const

protected

Generates the MzTabM Small Molecule Header.

Parameters

[in]	meta	MzTabMMetaData
[in]	optional_columns	Add optional columns
[out]	n_columns	Stores the number of columns in the header

Returns

StringList with SMH entries

generateMzTabMSmallMoleculeSectionRow_()

std::string generateMzTabMSmallMoleculeSectionRow_ ( const MzTabMSmallMoleculeSectionRow &  row, const std::vector< std::string > &  optional_columns, size_t &  n_columns  ) const

protected

Generates the MzTabM Small Molecule Section.

Parameters

[in]	row	MzTabMSmallMoleculeSectionRow
[in]	optional_columns	Add optional columns
[out]	n_columns	Stores the number of columns per row

Returns

StringList with SML entries

store()

void store	(	const std::string &	filename,
		const MzTabM &	mztab_m
	)		const

Store MzTabM file.