File adapter for MzData files. More...
#include <OpenMS/FORMAT/MzDataFile.h>
Public Member Functions | |
| MzDataFile () | |
| Default constructor. | |
| ~MzDataFile () | |
| 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 MzData file. | |
| template<typename MapType > | |
| void | store (const String &filename, const MapType &map) const |
| Stores a map in a MzData file. | |
| bool | isSemanticallyValid (const String &filename, StringList &errors, StringList &warnings) |
| Checks if a file is valid with respect to the mapping file and the controlled vocabulary. | |
Private Attributes | |
| PeakFileOptions | options_ |
| Options for loading / storing. | |
Detailed Description
File adapter for MzData files.
Constructor & Destructor Documentation
| MzDataFile | ( | ) |
Default constructor.
| ~MzDataFile | ( | ) |
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.
| bool isSemanticallyValid | ( | const String & | filename, | |
| StringList & | errors, | |||
| StringList & | warnings | |||
| ) |
Checks if a file is valid with respect to the mapping file and the controlled vocabulary.
- Parameters:
-
filename File name of the file to be checked. errors Errors during the validation are returned in this output parameter. warnings Warnings during the validation are returned in this output parameter.
- Exceptions:
-
Exception::FileNotFound is thrown if the file could not be opened
| void load | ( | const String & | filename, | |
| MapType & | map | |||
| ) | [inline] |
Loads a map from a MzData 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 MzDataHandler< MapType >::setOptions().
Referenced by FileHandler::loadExperiment().
| void store | ( | const String & | filename, | |
| const MapType & | map | |||
| ) | const [inline] |
Stores a map in a MzData file.
map has to be a MSExperiment or have the same interface.
- Exceptions:
-
Exception::UnableToCreateFile is thrown if the file could not be created
References MzDataHandler< MapType >::setOptions().
Referenced by FileHandler::storeExperiment().
Member Data Documentation
PeakFileOptions options_ [private] |
Options for loading / storing.
| OpenMS / TOPP release 1.10.0 | Documentation generated on Thu Mar 7 2013 09:42:54 using doxygen 1.7.1 |