aGrUM
3.2.0
a C++ library for (probabilistic) graphical models
Toggle main menu visibility
BIFXMLBNReader.h
Go to the documentation of this file.
1
/****************************************************************************
2
* This file is part of the aGrUM/pyAgrum library. *
3
* *
4
* Copyright (c) 2005-2026 by *
5
* - Pierre-Henri WUILLEMIN(_at_LIP6) *
6
* - Christophe GONZALES(_at_AMU) *
7
* *
8
* The aGrUM/pyAgrum library is free software; you can redistribute it *
9
* and/or modify it under the terms of either : *
10
* *
11
* - the GNU Lesser General Public License as published by *
12
* the Free Software Foundation, either version 3 of the License, *
13
* or (at your option) any later version, *
14
* - the MIT license (MIT), *
15
* - or both in dual license, as here. *
16
* *
17
* (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html) *
18
* *
19
* This aGrUM/pyAgrum library is distributed in the hope that it will be *
20
* useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, *
21
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
22
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *
23
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
24
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, *
25
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR *
26
* OTHER DEALINGS IN THE SOFTWARE. *
27
* *
28
* See LICENCES for more details. *
29
* *
30
* SPDX-FileCopyrightText: Copyright 2005-2026 *
31
* - Pierre-Henri WUILLEMIN(_at_LIP6) *
32
* - Christophe GONZALES(_at_AMU) *
33
* SPDX-License-Identifier: LGPL-3.0-or-later OR MIT *
34
* *
35
* Contact : info_at_agrum_dot_org *
36
* homepage : http://agrum.gitlab.io *
37
* gitlab : https://gitlab.com/agrumery/agrum *
38
* *
39
****************************************************************************/
40
41
91
#ifndef GUM_BIF_XML_BN_READER_H
92
#define GUM_BIF_XML_BN_READER_H
93
94
#include <istream>
95
#include <iterator>
96
#include <list>
97
#include <sstream>
98
#include <string>
99
100
#include <
agrum/agrum.h
>
101
102
#include <
agrum/base/variables/labelizedVariable.h
>
103
#include <
agrum/BN/io/BNReader.h
>
104
#include <
agrum/BN/io/xml/XmlDocument.h
>
105
106
namespace
gum
{
107
120
template
< GUM_Numeric GUM_SCALAR >
121
class
BIFXMLBNReader
:
BNReader
< GUM_SCALAR > {
122
public
:
128
BIFXMLBNReader
(BayesNet< GUM_SCALAR >* bn, std::string_view filePath);
129
136
BIFXMLBNReader
(BayesNet< GUM_SCALAR >* bn, std::istream& stream);
137
141
~BIFXMLBNReader
()
override
;
142
149
Size
proceed
() final;
150
156
typename
gum
::
Signaler
<
int
,
std
::
string
>
onProceed
;
157
158
private:
162
void
_parsingVariables_
(
XmlElement
parentNetwork);
163
167
void
_fillingBN_
(
XmlElement
parentNetwork);
168
173
BayesNet
< GUM_SCALAR >*
_bn_
;
174
178
std
::
string
_filePath_
;
179
183
std
::
string
_xmlContent_
;
184
188
bool
_isFromStream_
{
false
};
189
};
190
191
192
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
193
extern
template
class
GUM_PUBLIC_BN
BIFXMLBNReader< double >
;
194
#endif
195
196
}
/* namespace gum */
197
198
#include <
agrum/BN/io/BIFXML/BIFXMLBNReader_tpl.h
>
199
200
#endif
// GUM_BIF_XML_BN_READER_H
BIFXMLBNReader_tpl.h
BNReader.h
Definition of abstract classes for file input manipulation of Bayesian networks.
XmlDocument.h
Opaque facade over the vendored ticpp/tinyxml XML parser.
agrum.h
gum::BIFXMLBNReader::_xmlContent_
std::string _xmlContent_
XML content when constructed from a stream (empty otherwise).
Definition
BIFXMLBNReader.h:183
gum::BIFXMLBNReader::_parsingVariables_
void _parsingVariables_(XmlElement parentNetwork)
Parsing xml element containing data on variables.
gum::BIFXMLBNReader::BIFXMLBNReader
BIFXMLBNReader(BayesNet< GUM_SCALAR > *bn, std::istream &stream)
Constructor from an input stream.
gum::BIFXMLBNReader::_isFromStream_
bool _isFromStream_
True when the XML was provided via a stream rather than a file path.
Definition
BIFXMLBNReader.h:188
gum::BIFXMLBNReader::_filePath_
std::string _filePath_
the path to the xml filePath
Definition
BIFXMLBNReader.h:178
gum::BIFXMLBNReader::_fillingBN_
void _fillingBN_(XmlElement parentNetwork)
fill the diagram
gum::BIFXMLBNReader::onProceed
gum::Signaler< int, std::string > onProceed
Signaler used to indicates how many percent of the Xml files have been parsed yet.
Definition
BIFXMLBNReader.h:156
gum::BIFXMLBNReader::BIFXMLBNReader
BIFXMLBNReader(BayesNet< GUM_SCALAR > *bn, std::string_view filePath)
Constructor A reader is created to reading a defined file.
gum::BIFXMLBNReader::_bn_
BayesNet< GUM_SCALAR > * _bn_
An handle to the bayes net in which will be load the content of the xml filePath.
Definition
BIFXMLBNReader.h:173
gum::BIFXMLBNReader::proceed
Size proceed() final
Reads the bayes net from the file referenced by filePath given at the creation of class.
gum::BIFXMLBNReader::~BIFXMLBNReader
~BIFXMLBNReader() override
Default destructor.
gum::BNReader::BNReader
BNReader(BayesNet< GUM_SCALAR > *bn, std::string_view filename)
Constructor A reader is defined for reading a defined file.
gum::BayesNet
Class representing a Bayesian network.
Definition
BayesNet.h:99
gum::Signaler
Variadic template signaler for any number of arguments.
Definition
signaler.h:236
gum::XmlElement
A non-owning handle to an XML element, opaque over ticpp::Element.
Definition
XmlDocument.h:89
gum::Size
std::size_t Size
In aGrUM, hashed values are unsigned long int.
Definition
types.h:74
labelizedVariable.h
Base class for labelized discrete random variables.
gum
gum is the global namespace for all aGrUM entities
Definition
agrum.h:46
gum::BIFXMLBNReader< double >
template class GUM_PUBLIC_BN BIFXMLBNReader< double >
Definition
BIFXMLBNReader.cpp:52
std
STL namespace.
aGrUM
3.2.0
© PHW&CG&others - 2022
DoXyGeN 1.18.0