OpenMS  2.8.0
Public Member Functions | Protected Member Functions | List of all members
MzTabMFile Class Reference

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

#include <OpenMS/FORMAT/MzTabMFile.h>

Public Member Functions

 MzTabMFile ()
 Default Constructor. More...
 
 ~MzTabMFile ()
 Default Destructor. More...
 
void store (const String &filename, const MzTabM &mztab_m) const
 Store MzTabM file. More...
 

Protected Member Functions

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

Detailed Description

File adapter for MzTab-M files.

Constructor & Destructor Documentation

◆ 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
mapMzTabMMetaData
slFill Stringlist with MztabM MetaData entries

◆ generateMzTabMSmallMoleculeEvidenceHeader_()

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

Generates the MzTabM Small Molecule Header.

Parameters
mapMzTabMMetaData
optional_columnsAdd optional columns
n_columnsStores the number of columns in the header
Returns
StringList with SEH entries

◆ generateMzTabMSmallMoleculeEvidenceSectionRow_()

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

Generates the MzTabM Small Molecule Evidence Section.

Parameters
rowMzTabMSmallMoleculeFeatureSectionRow
optional_columnsAdd optional columns
n_columnsStores the number of columns per row
Returns
StringList with SME entries

◆ generateMzTabMSmallMoleculeFeatureHeader_()

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

Generates the MzTabM Small Molecule Header.

Parameters
mapMzTabMMetaData
optional_columnsAdd optional columns
n_columnsStores the number of columns in the header
Returns
StringList with SFH entries

◆ generateMzTabMSmallMoleculeFeatureSectionRow_()

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

Generates the MzTabM Small Molecule Feature Section.

Parameters
rowMzTabMSmallMoleculeFeatureSectionRow
optional_columnsAdd optional columns
n_columnsStores the number of columns per row
Returns
StringList with SMF entries

◆ generateMzTabMSmallMoleculeHeader_()

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

Generates the MzTabM Small Molecule Header.

Parameters
mapMzTabMMetaData
optional_columnsAdd optional columns
n_columnsStores the number of columns in the header
Returns
StringList with SMH entries

◆ generateMzTabMSmallMoleculeSectionRow_()

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

Generates the MzTabM Small Molecule Section.

Parameters
rowMzTabMSmallMoleculeSectionRow
optional_columnsAdd optional columns
n_columnsStores the number of columns per row
Returns
StringList with SML entries

◆ store()

void store ( const String filename,
const MzTabM mztab_m 
) const

Store MzTabM file.