OpenMS
2.5.0
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
File Members
OpenMS
FORMAT
ParamXMLFile.h
Go to the documentation of this file.
1
// --------------------------------------------------------------------------
2
// OpenMS -- Open-Source Mass Spectrometry
3
// --------------------------------------------------------------------------
4
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5
// ETH Zurich, and Freie Universitaet Berlin 2002-2020.
6
//
7
// This software is released under a three-clause BSD license:
8
// * Redistributions of source code must retain the above copyright
9
// notice, this list of conditions and the following disclaimer.
10
// * Redistributions in binary form must reproduce the above copyright
11
// notice, this list of conditions and the following disclaimer in the
12
// documentation and/or other materials provided with the distribution.
13
// * Neither the name of any author or any participating institution
14
// may be used to endorse or promote products derived from this software
15
// without specific prior written permission.
16
// For a full list of authors, refer to the file AUTHORS.
17
// --------------------------------------------------------------------------
18
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
//
30
// --------------------------------------------------------------------------
31
// $Maintainer: Timo Sachsenberg $
32
// $Authors: Stephan Aiche $
33
// --------------------------------------------------------------------------
34
35
#pragma once
36
37
#include <
OpenMS/FORMAT/XMLFile.h
>
38
#include <
OpenMS/DATASTRUCTURES/Param.h
>
39
40
namespace
OpenMS
41
{
49
class
OPENMS_DLLAPI
ParamXMLFile
:
50
public
Internal::XMLFile
51
{
52
public
:
54
ParamXMLFile
();
55
64
void
store(
const
String
& filename,
const
Param
& param)
const
;
65
72
void
writeXMLToStream(std::ostream* os_ptr,
const
Param
& param)
const
;
73
83
void
load(
const
String
& filename,
Param
& param);
84
};
85
86
}
// namespace OpenMS
87
88
XMLFile.h
OpenMS::String
A more convenient string class.
Definition:
String.h:58
OpenMS::ParamXMLFile
The file pendant of the Param class used to load and store the param datastructure as paramXML.
Definition:
ParamXMLFile.h:49
OpenMS
Main OpenMS namespace.
Definition:
FeatureDeconvolution.h:46
Param.h
OpenMS::Internal::XMLFile
Base class for loading/storing XML files that have a handler derived from XMLHandler.
Definition:
XMLFile.h:48
OpenMS::Param
Management and storage of parameters / INI files.
Definition:
Param.h:73
Generated on Sat Mar 7 2020 03:23:39 for OpenMS by
1.8.16