OpenMS
ParamXMLFile.h
Go to the documentation of this file.
1 // Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
2 // SPDX-License-Identifier: BSD-3-Clause
3 //
4 // --------------------------------------------------------------------------
5 // $Maintainer: Timo Sachsenberg $
6 // $Authors: Stephan Aiche $
7 // --------------------------------------------------------------------------
8 
9 #pragma once
10 
11 #include <OpenMS/FORMAT/XMLFile.h>
12 #include <OpenMS/DATASTRUCTURES/Param.h>
13 
14 namespace OpenMS
15 {
23  class OPENMS_DLLAPI ParamXMLFile :
24  public Internal::XMLFile
25  {
26 public:
28  ParamXMLFile();
29 
38  void store(const String& filename, const Param& param) const;
39 
46  void writeXMLToStream(std::ostream* os_ptr, const Param& param) const;
47 
57  void load(const String& filename, Param& param);
58  };
59 
60 } // namespace OpenMS
61 
62 
OpenMS::Internal::XMLFile
Base class for loading/storing XML files that have a handler derived from XMLHandler.
Definition: XMLFile.h:23
OpenMS::ParamXMLFile
The file pendant of the Param class used to load and store the param datastructure as paramXML.
Definition: ParamXMLFile.h:25
OpenMS::ParamXMLFile::store
void store(const String &filename, const Param &param) const
Write XML file.
OpenMS::ParamXMLFile::load
void load(const String &filename, Param &param)
Read XML file.
OpenMS::ParamXMLFile::ParamXMLFile
ParamXMLFile()
Constructor.
OpenMS::ParamXMLFile::writeXMLToStream
void writeXMLToStream(std::ostream *os_ptr, const Param &param) const
Write XML to output stream.
OpenMS::Param
Management and storage of parameters / INI files.
Definition: Param.h:44
OpenMS::String
A more convenient string class.
Definition: String.h:34
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:22