Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Member Functions

ParamXMLFile Class Reference

The file pendant of the Param class used to load and store the param datastructure as paramXML. More...

#include <OpenMS/FORMAT/ParamXMLFile.h>

Inheritance diagram for ParamXMLFile:
XMLFile

List of all members.

Public Member Functions

 ParamXMLFile ()
 Constructor.
void store (const String &filename, const Param &param) const
 Write XML file.
void writeXMLToStream (std::ostream *os_ptr, const Param &param) const
 Write XML to output stream.
void load (const String &filename, Param &param)
 Read XML file.

Detailed Description

The file pendant of the Param class used to load and store the param datastructure as paramXML.

Constructor & Destructor Documentation

ParamXMLFile (  ) 

Constructor.

Member Function Documentation

void load ( const String &  filename,
Param &  param 
)

Read XML file.

Parameters:
filename The file from where to read the Param object.
param The param object where the read data should be stored.
Exceptions:
Exception::FileNotFound is thrown if the file could not be found
Exception::ParseError is thrown if an error occurs during parsing

Referenced by TOPPViewBase::loadPreferences(), TOPPASBase::loadPreferences(), main(), and INIFileEditorWindow::openFile().

void store ( const String &  filename,
const Param &  param 
) const

Write XML file.

Parameters:
filename The filename where the param data structure should be stored.
param The Param class that should be stored in the file.
Exceptions:
Exception::UnableToCreateFile is thrown if the file could not be created

Referenced by INIFileEditorWindow::saveFile(), INIFileEditorWindow::saveFileAs(), TOPPViewBase::savePreferences(), and TOPPASBase::savePreferences().

void writeXMLToStream ( std::ostream *  os_ptr,
const Param &  param 
) const

Write XML to output stream.

Parameters:
os_ptr The stream where the param class should be written to.
param The Param class that should be written to the stream.
OpenMS / TOPP release 1.10.0 Documentation generated on Thu Mar 7 2013 09:42:54 using doxygen 1.7.1