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

ConsensusXMLFile Class Reference
[File IO]

#include <OpenMS/FORMAT/ConsensusXMLFile.h>

Inheritance diagram for ConsensusXMLFile:

XMLFile

List of all members.


Detailed Description

This class provides Input functionality for ConsensusMaps and Output functionality for StarAlignments.

This class can be used to load the content of a consensusXML file into a ConsensusMap or to save the content of a StarAlignment object into an XML file.

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

Public Member Functions

 ConsensusXMLFile ()
 Default constructor.
 ~ConsensusXMLFile ()
 Destructor.
template<typename ElementT>
void load (const String &filename, ConsensusMap< ElementT > &map, bool load_element_maps=true) throw (Exception::FileNotFound, Exception::ParseError)
 Loads a consenus map from a ConsensusXML file.
template<typename AlignmentT>
void store (const String &filename, const AlignmentT &alignment) const throw (Exception::UnableToCreateFile)
 Stores a staralignment object into consensusXML format.


Constructor & Destructor Documentation

ConsensusXMLFile (  ) 

Default constructor.

~ConsensusXMLFile (  ) 

Destructor.


Member Function Documentation

void load ( const String filename,
ConsensusMap< ElementT > &  map,
bool  load_element_maps = true 
) throw (Exception::FileNotFound, Exception::ParseError) [inline]

Loads a consenus map from a ConsensusXML file.

void store ( const String filename,
const AlignmentT &  alignment 
) const throw (Exception::UnableToCreateFile) [inline]

Stores a staralignment object into consensusXML format.


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