gum::BIFReader< GUM_SCALAR > Class Template Reference

Definition of templatized reader of BIF files for Bayesian networks. More...

#include <agrum/BN/io/BIF/BIFReader.h>

Inheritance diagram for gum::BIFReader< GUM_SCALAR >:

Collaboration diagram for gum::BIFReader< GUM_SCALAR >:

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

Protected Attributes
BayesNet< GUM_SCALAR > *	bn__
BayesNetFactory< GUM_SCALAR > *	factory__
BIF::Scanner *	scanner__
BIF::Parser *	parser__
std::string	streamName__
bool	traceScanning__
bool	parseDone__
bool	ioerror__

Detailed Description

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

Definition of templatized reader of BIF files for Bayesian networks.

how to use it :

// OPTIONAL LISTENER CLASS
class aSimpleListener : public gum::Listener {
public:
  void whenLoading(const void *buffer,int percent) {
  // percent goes from 0 to 100 (whenLoading is called at most once for each
integer between 0 and 100
    // percent=200 recieved when End Of File.
 }
};
// END OF OPTIONAL LISTENER

 gum::BayesNet<double> bn;

 try {
  gum::BIFReader<double> reader(&bn,std::string(args[1]));

  // OPTIONAL SECTION
  aSimpleListener l;
  GUM_CONNECT(reader.scanner(),onLoad,l,aSimpleListener::whenLoading);
  // END OF OPTIONNAL SECTION

  if (reader.proceed()==0) {
   std::cerr<<"Well done !"<<std::endl;
  } else {
   reader.showElegantErrorsAndWarnings();
   reader.showErrorCounts();
  }
 } catch (gum::IOError& e) {GUM_SHOWERROR(e);}

  return 0;

Author

Pierre-Henri WUILLEMIN()

Definition at line 125 of file BIFReader.h.

Constructor & Destructor Documentation

BIFReader()

template<typename GUM_SCALAR>

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

~BIFReader()

template<typename GUM_SCALAR>

gum::BIFReader< GUM_SCALAR >::~BIFReader ( )

final

Member Function Documentation

errCol()

template<typename GUM_SCALAR>

Idx gum::BIFReader< GUM_SCALAR >::errCol

(

Idx

i

)

col of ith error or warning

errIsError()

template<typename GUM_SCALAR>

bool gum::BIFReader< GUM_SCALAR >::errIsError

(

Idx

i

)

type of ith error or warning

errLine()

template<typename GUM_SCALAR>

Idx gum::BIFReader< GUM_SCALAR >::errLine

(

Idx

i

)

line of ith error or warning

errMsg()

template<typename GUM_SCALAR>

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

(

Idx

i

)

message of ith error or warning

errors()

template<typename GUM_SCALAR>

Size gum::BIFReader< GUM_SCALAR >::errors

(

)

publishing Errors API

of errors

proceed()

template<typename GUM_SCALAR>

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

finalvirtual

parse.

Returns

the number of detected errors

Exceptions

IOError

if file not exists

Implements gum::BNReader< GUM_SCALAR >.

scanner()

template<typename GUM_SCALAR>

BIF::Scanner& gum::BIFReader< GUM_SCALAR >::scanner

(

)

Direct access to BIF scanner (mandatory for listener connection)

Exceptions

IOError

if file not exists

showElegantErrors()

template<typename GUM_SCALAR>

void gum::BIFReader< GUM_SCALAR >::showElegantErrors

(

std::ostream &

o = std::cerr

)

send on std::cerr the list of errors

showElegantErrorsAndWarnings()

template<typename GUM_SCALAR>

void gum::BIFReader< GUM_SCALAR >::showElegantErrorsAndWarnings

(

std::ostream &

o = std::cerr

)

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

showErrorCounts()

template<typename GUM_SCALAR>

void gum::BIFReader< GUM_SCALAR >::showErrorCounts

(

std::ostream &

o = std::cerr

)

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

streamName()

template<typename GUM_SCALAR>

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

(

)

const

name of readen file

trace() [1/2]

template<typename GUM_SCALAR>

bool gum::BIFReader< GUM_SCALAR >::trace

(

)

const

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

trace() [2/2]

template<typename GUM_SCALAR>

void gum::BIFReader< GUM_SCALAR >::trace

(

bool

b

)

warnings()

template<typename GUM_SCALAR>

Size gum::BIFReader< GUM_SCALAR >::warnings

(

)

of errors

Member Data Documentation

bn__

template<typename GUM_SCALAR>

BayesNet< GUM_SCALAR >* gum::BIFReader< GUM_SCALAR >::bn__

protected

Definition at line 175 of file BIFReader.h.

factory__

template<typename GUM_SCALAR>

BayesNetFactory< GUM_SCALAR >* gum::BIFReader< GUM_SCALAR >::factory__

protected

Definition at line 176 of file BIFReader.h.

ioerror__

template<typename GUM_SCALAR>

bool gum::BIFReader< GUM_SCALAR >::ioerror__

protected

Definition at line 186 of file BIFReader.h.

parseDone__

template<typename GUM_SCALAR>

bool gum::BIFReader< GUM_SCALAR >::parseDone__

protected

Definition at line 182 of file BIFReader.h.

parser__

template<typename GUM_SCALAR>

BIF::Parser* gum::BIFReader< GUM_SCALAR >::parser__

protected

Definition at line 178 of file BIFReader.h.

scanner__

template<typename GUM_SCALAR>

BIF::Scanner* gum::BIFReader< GUM_SCALAR >::scanner__

protected

Definition at line 177 of file BIFReader.h.

streamName__

template<typename GUM_SCALAR>

std::string gum::BIFReader< GUM_SCALAR >::streamName__

protected

Definition at line 180 of file BIFReader.h.

traceScanning__

template<typename GUM_SCALAR>

bool gum::BIFReader< GUM_SCALAR >::traceScanning__

protected

Definition at line 181 of file BIFReader.h.

---

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

• agrum/BN/io/BIF/BIFReader.h