Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Types | Public Member Functions

MascotXMLFile Class Reference
[File IO]

Used to load MascotXML files. More...

#include <OpenMS/FORMAT/MascotXMLFile.h>

Inheritance diagram for MascotXMLFile:
XMLFile

List of all members.

Public Types

typedef
Internal::MascotXMLHandler::RTMapping 
RTMapping

Public Member Functions

 MascotXMLFile ()
 Constructor.
void load (const String &filename, ProteinIdentification &protein_identification, std::vector< PeptideIdentification > &id_data, const RTMapping &rt_mapping=RTMapping())
 loads data from a MascotXML file
void load (const String &filename, ProteinIdentification &protein_identification, std::vector< PeptideIdentification > &id_data, std::map< String, std::vector< AASequence > > &peptides, const RTMapping &rt_mapping=RTMapping())
 loads data from a MascotXML file

Detailed Description

Used to load MascotXML files.

This class is used to load documents that implement the schema of MascotXML files.


Member Typedef Documentation


Constructor & Destructor Documentation

MascotXMLFile (  ) 

Constructor.


Member Function Documentation

void load ( const String filename,
ProteinIdentification protein_identification,
std::vector< PeptideIdentification > &  id_data,
const RTMapping rt_mapping = RTMapping() 
)

loads data from a MascotXML file

Parameters:
filename the file to be loaded
protein_identification protein identifications belonging to the whole experiment
id_data the identifications with m/z and RT
An optional mapping of scan indices to RT, in case that the MascotXML file only has scan=XY values present
Exceptions:
Exception::FileNotFound is thrown if the file does not exists.
Exception::ParseError is thrown if the file does not suit to the standard.

This method serves to read in a MascotXML file. The information can be retrieved via the load function.

void load ( const String filename,
ProteinIdentification protein_identification,
std::vector< PeptideIdentification > &  id_data,
std::map< String, std::vector< AASequence > > &  peptides,
const RTMapping rt_mapping = RTMapping() 
)

loads data from a MascotXML file

Parameters:
filename the file to be loaded
protein_identification protein identifications belonging to the whole experiment
id_data the identifications with m/z and RT
peptides a map of modified peptides identified by the String title
An optional mapping of scan indices to RT, in case that the MascotXML file only has scan=XY values present
Exceptions:
Exception::FileNotFound is thrown if the file does not exists.
Exception::ParseError is thrown if the file does not suit to the standard.

This method serves to read in a MascotXML file. The information can be retrieved via the load function.


OpenMS / TOPP release 1.10.0 Documentation generated on Thu Mar 7 2013 09:42:54 using doxygen 1.7.1