ParamXMLFile#

class pyopenms.ParamXMLFile#

Bases: object

Cython implementation of _ParamXMLFile

Original C++ documentation is available here

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

__init__()#

Overload:

__init__(self) None

Overload:

__init__(self, in_0: ParamXMLFile) None

Methods

__init__

Overload:

load(self, in_0, in_1)

Read XML file

store(self, in_0, in_1)

Write XML file

load(self, in_0: bytes | str | String, in_1: Param) None#

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

Raises:

Exception: FileNotFound is thrown if the file could not be found

Raises:

Exception: ParseError is thrown if an error occurs during parsing

store(self, in_0: bytes | str | String, in_1: Param) None#

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