gum::NetReader< GUM_SCALAR > Class Template Reference

Pure virtual class for reading a BN from a file. More...

#include <agrum/BN/io/net/netReader.h>

Inheritance diagram for gum::NetReader< GUM_SCALAR >:

Collaboration diagram for gum::NetReader< GUM_SCALAR >:

Public Member Functions
	NetReader (BayesNet< GUM_SCALAR > *bn, const std::string &filename)
	Constructor A reader is defined for reading a defined file.
	~NetReader ()
	Default destructor.
net::Scanner &	scanner ()
	Direct access to DSL scanner (mandatory for listener connection).
const std::string &	streamName () const
	name of readen file
bool	trace () const
	accessor to trace function (just write the number of parser line)
void	trace (bool b)
Size	proceed () final
	parse.
Size	errors ()
	publishing Errors API
Size	warnings ()
Idx	errLine (Idx i)
	line of ith error or warning
Idx	errCol (Idx i)
	col of ith error or warning
bool	errIsError (Idx i)
	type of ith error or warning
std::string	errMsg (Idx i)
	message of ith error or warning
void	showElegantErrors (std::ostream &o=std::cerr)
	send on std::cerr the list of errorswith contents
void	showElegantErrorsAndWarnings (std::ostream &o=std::cerr)
	send on std::cerr the list of errors or warnings with contents
void	showErrorsAndWarnings (std::ostream &o=std::cerr)
	send on std::cerr the list of errors or warnings
void	showErrorCounts (std::ostream &o=std::cerr)
	send on std::cerr the number of errors and the number of warnings

Protected Attributes
BayesNet< GUM_SCALAR > *	_bn_
BayesNetFactory< GUM_SCALAR > *	_factory_
net::Scanner *	_scanner_
net::Parser *	_parser_
std::string	_streamName_
bool	_traceScanning_
bool	_parseDone_
bool	_ioerror_

Detailed Description

template<typename GUM_SCALAR>
class gum::NetReader< GUM_SCALAR >

Pure virtual class for reading a BN from a file.

Every class used to read the content of a Bayesian network from a stream, or a file must be a subclass of NetReader.

Definition at line 73 of file netReader.h.

Constructor & Destructor Documentation

NetReader()

template<typename GUM_SCALAR>

gum::NetReader< GUM_SCALAR >::NetReader	(	BayesNet< GUM_SCALAR > *	bn,
		const std::string &	filename )

Constructor A reader is defined for reading a defined file.

Hence the 2 args of the constructor. Note that the BN has to be built outside the reader. There is no delegation to create/destroy the BN from inside the reader.

~NetReader()

template<typename GUM_SCALAR>

gum::NetReader< GUM_SCALAR >::~NetReader

(

)

Default destructor.

Member Function Documentation

errCol()

template<typename GUM_SCALAR>

Idx gum::NetReader< GUM_SCALAR >::errCol

(

Idx

i

)

col of ith error or warning

References errCol().

Referenced by errCol().

Here is the call graph for this function:

Here is the caller graph for this function:

errIsError()

template<typename GUM_SCALAR>

bool gum::NetReader< GUM_SCALAR >::errIsError

(

Idx

i

)

type of ith error or warning

References errIsError().

Referenced by errIsError().

Here is the call graph for this function:

Here is the caller graph for this function:

errLine()

template<typename GUM_SCALAR>

Idx gum::NetReader< GUM_SCALAR >::errLine

(

Idx

i

)

line of ith error or warning

References errLine().

Referenced by errLine().

Here is the call graph for this function:

Here is the caller graph for this function:

errMsg()

template<typename GUM_SCALAR>

std::string gum::NetReader< GUM_SCALAR >::errMsg

(

Idx

i

)

message of ith error or warning

References errMsg().

Referenced by errMsg().

Here is the call graph for this function:

Here is the caller graph for this function:

errors()

template<typename GUM_SCALAR>

Size gum::NetReader< GUM_SCALAR >::errors

(

)

publishing Errors API

of errors

References errors().

Referenced by errors().

Here is the call graph for this function:

Here is the caller graph for this function:

proceed()

template<typename GUM_SCALAR>

Size gum::NetReader< GUM_SCALAR >::proceed ( )

final

parse.

Returns

the number of detected errors

Exceptions

IOError

if file not exists

scanner()

template<typename GUM_SCALAR>

net::Scanner & gum::NetReader< GUM_SCALAR >::scanner

(

)

Direct access to DSL scanner (mandatory for listener connection).

Exceptions

IOError

if file not exists

showElegantErrors()

template<typename GUM_SCALAR>

void gum::NetReader< GUM_SCALAR >::showElegantErrors

(

std::ostream &

o = std::cerr

)

send on std::cerr the list of errorswith contents

References showElegantErrors().

Referenced by showElegantErrors().

Here is the call graph for this function:

Here is the caller graph for this function:

showElegantErrorsAndWarnings()

template<typename GUM_SCALAR>

void gum::NetReader< GUM_SCALAR >::showElegantErrorsAndWarnings

(

std::ostream &

o = std::cerr

)

send on std::cerr the list of errors or warnings with contents

References showElegantErrorsAndWarnings().

Referenced by showElegantErrorsAndWarnings().

Here is the call graph for this function:

Here is the caller graph for this function:

showErrorCounts()

template<typename GUM_SCALAR>

void gum::NetReader< GUM_SCALAR >::showErrorCounts

(

std::ostream &

o = std::cerr

)

send on std::cerr the number of errors and the number of warnings

References showErrorCounts().

Referenced by showErrorCounts().

Here is the call graph for this function:

Here is the caller graph for this function:

showErrorsAndWarnings()

template<typename GUM_SCALAR>

void gum::NetReader< GUM_SCALAR >::showErrorsAndWarnings

(

std::ostream &

o = std::cerr

)

send on std::cerr the list of errors or warnings

References showErrorsAndWarnings().

Referenced by showErrorsAndWarnings().

Here is the call graph for this function:

Here is the caller graph for this function:

streamName()

template<typename GUM_SCALAR>

const std::string & gum::NetReader< GUM_SCALAR >::streamName

(

)

const

name of readen file

trace() [1/2]

template<typename GUM_SCALAR>

bool gum::NetReader< GUM_SCALAR >::trace

(

)

const

accessor to trace function (just write the number of parser line)

trace() [2/2]

template<typename GUM_SCALAR>

void gum::NetReader< GUM_SCALAR >::trace

(

bool

b

)

warnings()

template<typename GUM_SCALAR>

Size gum::NetReader< GUM_SCALAR >::warnings

(

)

of errors

References warnings().

Referenced by warnings().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_bn_

template<typename GUM_SCALAR>

BayesNet< GUM_SCALAR >* gum::NetReader< GUM_SCALAR >::_bn_

protected

Definition at line 138 of file netReader.h.

_factory_

template<typename GUM_SCALAR>

BayesNetFactory< GUM_SCALAR >* gum::NetReader< GUM_SCALAR >::_factory_

protected

Definition at line 139 of file netReader.h.

_ioerror_

template<typename GUM_SCALAR>

bool gum::NetReader< GUM_SCALAR >::_ioerror_

protected

Definition at line 149 of file netReader.h.

_parseDone_

template<typename GUM_SCALAR>

bool gum::NetReader< GUM_SCALAR >::_parseDone_

protected

Definition at line 145 of file netReader.h.

_parser_

template<typename GUM_SCALAR>

net::Parser* gum::NetReader< GUM_SCALAR >::_parser_

protected

Definition at line 141 of file netReader.h.

_scanner_

template<typename GUM_SCALAR>

net::Scanner* gum::NetReader< GUM_SCALAR >::_scanner_

protected

Definition at line 140 of file netReader.h.

_streamName_

template<typename GUM_SCALAR>

std::string gum::NetReader< GUM_SCALAR >::_streamName_

protected

Definition at line 143 of file netReader.h.

_traceScanning_

template<typename GUM_SCALAR>

bool gum::NetReader< GUM_SCALAR >::_traceScanning_

protected

Definition at line 144 of file netReader.h.

---

The documentation for this class was generated from the following file:

• agrum/BN/io/net/netReader.h