aGrUM  0.13.2
gum::prm::PRMGenerator< GUM_SCALAR > Class Template Referenceabstract

This class is the base class to all PRM generators. More...

#include <agrum/PRM/generator/PRMGenerator.h>

+ Inheritance diagram for gum::prm::PRMGenerator< GUM_SCALAR >:
+ Collaboration diagram for gum::prm::PRMGenerator< GUM_SCALAR >:

Public Member Functions

Constructors and destructor.
 PRMGenerator ()
 Default constructor. More...
 
 PRMGenerator (const PRMGenerator &source)
 Copy constructor. More...
 
virtual ~PRMGenerator ()
 Destructor. More...
 
void setNameGenerator (const NameGenerator &name_gen)
 Getters and setters. More...
 
const NameGeneratorgetNameGenerator () const
 Returns the NameGenerator used by this generator. More...
 
virtual PRM< GUM_SCALAR > * generate ()=0
 Proceeds with the generation of the PRM. More...
 

Protected Attributes

NameGenerator _name_gen
 The name generator used by this class. More...
 

Detailed Description

template<typename GUM_SCALAR>
class gum::prm::PRMGenerator< GUM_SCALAR >

This class is the base class to all PRM generators.

Definition at line 46 of file PRMGenerator.h.

Constructor & Destructor Documentation

template<typename GUM_SCALAR >
INLINE gum::prm::PRMGenerator< GUM_SCALAR >::PRMGenerator ( )

Default constructor.

Definition at line 32 of file PRMGenerator_tpl.h.

32  {
33  GUM_CONSTRUCTOR(PRMGenerator);
34  }
PRMGenerator()
Default constructor.
template<typename GUM_SCALAR >
INLINE gum::prm::PRMGenerator< GUM_SCALAR >::PRMGenerator ( const PRMGenerator< GUM_SCALAR > &  source)

Copy constructor.

Definition at line 37 of file PRMGenerator_tpl.h.

37  :
38  _name_gen(source._name_gen) {
39  GUM_CONS_CPY(PRMGenerator);
40  }
PRMGenerator()
Default constructor.
NameGenerator _name_gen
The name generator used by this class.
Definition: PRMGenerator.h:78
template<typename GUM_SCALAR >
INLINE gum::prm::PRMGenerator< GUM_SCALAR >::~PRMGenerator ( )
virtual

Destructor.

Definition at line 43 of file PRMGenerator_tpl.h.

43  {
44  GUM_DESTRUCTOR(PRMGenerator);
45  }
PRMGenerator()
Default constructor.

Member Function Documentation

template<typename GUM_SCALAR >
virtual PRM< GUM_SCALAR >* gum::prm::PRMGenerator< GUM_SCALAR >::generate ( )
pure virtual

Proceeds with the generation of the PRM.

Implemented in gum::prm::LayerGenerator< GUM_SCALAR >, and gum::prm::ClusteredLayerGenerator< GUM_SCALAR >.

template<typename GUM_SCALAR >
INLINE const NameGenerator & gum::prm::PRMGenerator< GUM_SCALAR >::getNameGenerator ( ) const

Returns the NameGenerator used by this generator.

Definition at line 55 of file PRMGenerator_tpl.h.

References gum::prm::PRMGenerator< GUM_SCALAR >::_name_gen.

55  {
56  return _name_gen;
57  }
NameGenerator _name_gen
The name generator used by this class.
Definition: PRMGenerator.h:78
template<typename GUM_SCALAR >
INLINE void gum::prm::PRMGenerator< GUM_SCALAR >::setNameGenerator ( const NameGenerator name_gen)

Getters and setters.

Defines the NameGenerator used by this generator.

Definition at line 49 of file PRMGenerator_tpl.h.

References gum::prm::PRMGenerator< GUM_SCALAR >::_name_gen.

49  {
50  _name_gen = name_gen;
51  }
NameGenerator _name_gen
The name generator used by this class.
Definition: PRMGenerator.h:78

Member Data Documentation

template<typename GUM_SCALAR >
NameGenerator gum::prm::PRMGenerator< GUM_SCALAR >::_name_gen
protected

The name generator used by this class.

Definition at line 78 of file PRMGenerator.h.

Referenced by gum::prm::PRMGenerator< GUM_SCALAR >::getNameGenerator(), and gum::prm::PRMGenerator< GUM_SCALAR >::setNameGenerator().


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