Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

FeatureXMLFile Class Reference
[File IO]

#include <OpenMS/FORMAT/FeatureXMLFile.h>

Inheritance diagram for FeatureXMLFile:

XMLFile

List of all members.


Detailed Description

This class provides Input/Output functionality for feature maps.

A documented schema for this format can be found at http://open-ms.sourceforge.net/schemas/.

Note:
This format will eventually be replaced by the HUPO-PSI AnalysisXML format!

Public Member Functions

void load (String filename, FeatureMap<> &feature_map) throw (Exception::FileNotFound, Exception::ParseError)
 loads the file with name filename into map.
void store (String filename, const FeatureMap<> &feature_map) const throw (Exception::UnableToCreateFile)
 stores the map feature_map in file with name filename.
PeakFileOptionsgetOptions ()
 Mutable access to the options for loading/storing.
Constructors and Destructor


 FeatureXMLFile ()
 Default constructor.
 ~FeatureXMLFile ()
 Destructor.

Protected Attributes

PeakFileOptions options_

Constructor & Destructor Documentation

FeatureXMLFile (  ) 

Default constructor.

~FeatureXMLFile (  ) 

Destructor.


Member Function Documentation

void load ( String  filename,
FeatureMap<> &  feature_map 
) throw (Exception::FileNotFound, Exception::ParseError)

loads the file with name filename into map.

void store ( String  filename,
const FeatureMap<> &  feature_map 
) const throw (Exception::UnableToCreateFile)

stores the map feature_map in file with name filename.

PeakFileOptions& getOptions (  )  [inline]

Mutable access to the options for loading/storing.


Member Data Documentation

PeakFileOptions options_ [protected]


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:44 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1