Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Member Functions | Private Attributes | List of all members
IndexedMzMLFileLoader Class Reference

A class to load an indexedmzML file. More...

#include <OpenMS/FORMAT/IndexedMzMLFileLoader.h>

Public Member Functions

 IndexedMzMLFileLoader ()
 Constructor. More...
 
 ~IndexedMzMLFileLoader ()
 Destructor. More...
 
PeakFileOptionsgetOptions ()
 Mutable access to the options for loading/storing. More...
 
const PeakFileOptionsgetOptions () 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, OnDiscMSExperiment<> &exp)
 Load a file. More...
 
void store (const String &filename, OnDiscMSExperiment<> &exp)
 Store a file from an on-disc data-structure. More...
 
void store (const String &filename, MSExperiment<> &exp)
 Store a file from an in-memory data-structure. More...
 

Private Attributes

PeakFileOptions options_
 Options for storing. More...
 

Detailed Description

A class to load an indexedmzML file.

Providing the same interface as the other classes such as mzMLFile, mzXMLFile etc. to load a file.

Constructor & Destructor Documentation

Constructor.

Destructor.

Member Function Documentation

PeakFileOptions& getOptions ( )

Mutable access to the options for loading/storing.

const PeakFileOptions& getOptions ( ) const

Non-mutable access to the options for loading/storing.

bool load ( const String filename,
OnDiscMSExperiment<> &  exp 
)
inline

Load a file.

Tries to parse the file, success needs to be checked with the return value.

Parameters
filenameFilename determines where the file is located
expObject which will contain the data after the call
Returns
Indicates whether parsing was successful (if it is false, the file most likely was not an mzML or not indexed).

References OnDiscMSExperiment< PeakT, ChromatogramPeakT >::openFile().

void setOptions ( const PeakFileOptions )

set options for loading/storing

void store ( const String filename,
OnDiscMSExperiment<> &  exp 
)
inline
void store ( const String filename,
MSExperiment<> &  exp 
)
inline

Store a file from an in-memory data-structure.

Parameters
filenameFilename determines where the file will be stored
expMS data to be stored

References MzMLFile::setOptions(), and MzMLFile::store().

Member Data Documentation

PeakFileOptions options_
private

Options for storing.


OpenMS / TOPP release 2.0.0 Documentation generated on Wed Mar 30 2016 16:18:46 using doxygen 1.8.5