OpenMS
2.6.0
|
A class to load an indexedmzML file. More...
#include <OpenMS/FORMAT/IndexedMzMLFileLoader.h>
Public Member Functions | |
IndexedMzMLFileLoader () | |
Constructor. More... | |
~IndexedMzMLFileLoader () | |
Destructor. More... | |
PeakFileOptions & | getOptions () |
Mutable access to the options for loading/storing. More... | |
const PeakFileOptions & | getOptions () const |
Non-mutable access to the options for loading/storing. More... | |
void | setOptions (const PeakFileOptions &) |
set options for loading/storing More... | |
bool | load (const String &filename, OnDiscPeakMap &exp) |
Load a file. More... | |
void | store (const String &filename, OnDiscPeakMap &exp) |
Store a file from an on-disc data-structure. More... | |
void | store (const String &filename, PeakMap &exp) |
Store a file from an in-memory data-structure. More... | |
Private Attributes | |
PeakFileOptions | options_ |
Options for storing. More... | |
A class to load an indexedmzML file.
Providing the same interface as the other classes such as MzMLFile, MzXMLFile etc. to load and store a file. Reading a file from disk will load the file into a OnDiscMSExperiment while the class can write to disk both, a MSExperiment and a OnDiscMSExperiment.
Constructor.
Destructor.
PeakFileOptions& getOptions | ( | ) |
Mutable access to the options for loading/storing.
const PeakFileOptions& getOptions | ( | ) | const |
Non-mutable access to the options for loading/storing.
|
inline |
Load a file.
Tries to parse the file, success needs to be checked with the return value.
filename | Filename determines where the file is located |
exp | Object which will contain the data after the call |
References OnDiscMSExperiment::openFile().
void setOptions | ( | const PeakFileOptions & | ) |
set options for loading/storing
|
inline |
Store a file from an on-disc data-structure.
filename | Filename determines where the file will be stored |
exp | MS data to be stored |
References OpenMS::Constants::c, MSDataWritingConsumer::consumeChromatogram(), MSDataWritingConsumer::consumeSpectrum(), OnDiscMSExperiment::getChromatogram(), OnDiscMSExperiment::getExperimentalSettings(), OnDiscMSExperiment::getNrChromatograms(), OnDiscMSExperiment::getNrSpectra(), OnDiscMSExperiment::getSpectrum(), MSDataWritingConsumer::setExpectedSize(), MSDataWritingConsumer::setExperimentalSettings(), and MzMLHandler::setOptions().
Store a file from an in-memory data-structure.
filename | Filename determines where the file will be stored |
exp | MS data to be stored |
References MzMLFile::setOptions(), and MzMLFile::store().
|
private |
Options for storing.