aGrUM 3.0.0
a C++ library for (probabilistic) graphical models
gum::IDReader< GUM_SCALAR > Class Template Referenceabstract

Pure virtual class for importing an ID from a file. More...

#include <IDReader.h>

Inheritance diagram for gum::IDReader< GUM_SCALAR >:

Public Member Functions

 IDReader (InfluenceDiagram< GUM_SCALAR > *infdiag, std::string_view filePath)
 Constructor A reader is created to reading a defined file.
virtual ~IDReader ()
 Default destructor.
virtual Size proceed ()=0
 Reads the influence diagram from the file referenced by filePath given at the creation of class.

Detailed Description

template<GUM_Numeric GUM_SCALAR>
class gum::IDReader< GUM_SCALAR >

Pure virtual class for importing an ID from a file.

All classes used to read an influence diagram from a file must inherit from this class

Definition at line 76 of file IDReader.h.

Constructor & Destructor Documentation

◆ IDReader()

template<GUM_Numeric GUM_SCALAR>
gum::IDReader< GUM_SCALAR >::IDReader ( InfluenceDiagram< GUM_SCALAR > * infdiag,
std::string_view filePath )

Constructor A reader is created to reading a defined file.

Note that an ID as to be created before and given in parameter.

◆ ~IDReader()

template<GUM_Numeric GUM_SCALAR>
virtual gum::IDReader< GUM_SCALAR >::~IDReader ( )
virtual

Default destructor.

Member Function Documentation

◆ proceed()

template<GUM_Numeric GUM_SCALAR>
virtual Size gum::IDReader< GUM_SCALAR >::proceed ( )
pure virtual

Reads the influence diagram from the file referenced by filePath given at the creation of class.

Returns
Returns the number of error during the parsing (0 if none).

Implemented in gum::BIFXMLIDReader< GUM_SCALAR >, and gum::GumIDReader< GUM_SCALAR >.


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