File adapter for MzXML 2.1 files. More...
#include <OpenMS/FORMAT/MzXMLFile.h>
Inheritance diagram for MzXMLFile:
Public Member Functions | |
| MzXMLFile () | |
| Default constructor. | |
| ~MzXMLFile () | |
| Destructor. | |
| PeakFileOptions & | getOptions () |
| Mutable access to the options for loading/storing. | |
| const PeakFileOptions & | getOptions () const |
| Non-mutable access to the options for loading/storing. | |
| template<typename MapType > | |
| void | load (const String &filename, MapType &map) |
| Loads a map from a MzXML file. | |
| template<typename MapType > | |
| void | store (const String &filename, const MapType &map) const |
| Stores a map in a MzXML file. | |
Private Attributes | |
| PeakFileOptions | options_ |
Detailed Description
File adapter for MzXML 2.1 files.
Constructor & Destructor Documentation
| MzXMLFile | ( | ) |
Default constructor.
| ~MzXMLFile | ( | ) |
Destructor.
Member Function Documentation
| PeakFileOptions& getOptions | ( | ) |
Mutable access to the options for loading/storing.
Referenced by FileHandler::loadExperiment(), and FileHandler::storeExperiment().
| const PeakFileOptions& getOptions | ( | ) | const |
Non-mutable access to the options for loading/storing.
| void load | ( | const String & | filename, | |
| MapType & | map | |||
| ) | [inline] |
Loads a map from a MzXML file.
map has to be a MSExperiment or have the same interface.
- Exceptions:
-
Exception::FileNotFound is thrown if the file could not be opened Exception::ParseError is thrown if an error occurs during parsing
References MzXMLHandler< MapType >::setOptions().
Referenced by FileHandler::loadExperiment().
| void store | ( | const String & | filename, | |
| const MapType & | map | |||
| ) | const [inline] |
Stores a map in a MzXML file.
map has to be a MSExperiment or have the same interface.
- Exceptions:
-
Exception::UnableToCreateFile is thrown if the file could not be created
Referenced by FileHandler::storeExperiment().
Member Data Documentation
PeakFileOptions options_ [private] |
| OpenMS / TOPP release 1.10.0 | Documentation generated on Thu Mar 7 2013 09:42:54 using doxygen 1.7.1 |