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

Pure virtual class for exporting an ID. More...

#include <IDWriter.h>

+ Inheritance diagram for gum::IDWriter< GUM_SCALAR >:

Public Member Functions

 IDWriter ()
 Default constructor. More...
 
virtual ~IDWriter ()
 Default destructor. More...
 
virtual void write (std::ostream &output, const InfluenceDiagram< GUM_SCALAR > &infdiag)=0
 Writes an influence diagram in the given ouput stream. More...
 
virtual void write (std::string filePath, const InfluenceDiagram< GUM_SCALAR > &infdiag)=0
 Writes an Influence Diagram in the file referenced by filePath. More...
 

Detailed Description

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

Pure virtual class for exporting an ID.

All classes used to write an influence diagram in a stream or a file must inherit from this class

Definition at line 51 of file IDWriter.h.

Constructor & Destructor Documentation

◆ IDWriter()

template<typename GUM_SCALAR >
gum::IDWriter< GUM_SCALAR >::IDWriter ( )

Default constructor.

◆ ~IDWriter()

template<typename GUM_SCALAR >
virtual gum::IDWriter< GUM_SCALAR >::~IDWriter ( )
virtual

Default destructor.

Member Function Documentation

◆ write() [1/2]

template<typename GUM_SCALAR >
virtual void gum::IDWriter< GUM_SCALAR >::write ( std::ostream &  output,
const InfluenceDiagram< GUM_SCALAR > &  infdiag 
)
pure virtual

Writes an influence diagram in the given ouput stream.

Parameters
outputThe output stream.
infdiagThe influence diagram writen in the stream.
Exceptions
IOErrorRaised if an I/O error occurs.

Implemented in gum::BIFXMLIDWriter< GUM_SCALAR >.

◆ write() [2/2]

template<typename GUM_SCALAR >
virtual void gum::IDWriter< GUM_SCALAR >::write ( std::string  filePath,
const InfluenceDiagram< GUM_SCALAR > &  infdiag 
)
pure virtual

Writes an Influence Diagram in the file referenced by filePath.

If the file doesn't exists, it is created. If the file exists, it's content will be erased.

Parameters
filePathThe path to the file used to write the Influence Diagram.
infdiagThe Influence Diagram writen in the file.
Exceptions
IOErrorRaised if an I/O error occurs.

Implemented in gum::BIFXMLIDWriter< GUM_SCALAR >.


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