gum::prm::PRMGenerator< GUM_SCALAR > Class Template Reference

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 NameGenerator &	getNameGenerator () 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 49 of file PRMGenerator.h.

Constructor & Destructor Documentation

PRMGenerator() [1/2]

template<typename GUM_SCALAR >

INLINE gum::prm::PRMGenerator< GUM_SCALAR >::PRMGenerator

(

)

Default constructor.

Definition at line 35 of file PRMGenerator_tpl.h.

                                                    {
      GUM_CONSTRUCTOR(PRMGenerator);
    }

PRMGenerator() [2/2]

template<typename GUM_SCALAR >

INLINE gum::prm::PRMGenerator< GUM_SCALAR >::PRMGenerator

(

const PRMGenerator< GUM_SCALAR > &

source

)

Copy constructor.

Definition at line 40 of file PRMGenerator_tpl.h.

                                                                              :
        _name_gen(source._name_gen) {
      GUM_CONS_CPY(PRMGenerator);
    }

~PRMGenerator()

template<typename GUM_SCALAR >

INLINE gum::prm::PRMGenerator< GUM_SCALAR >::~PRMGenerator ( )

virtual

Destructor.

Definition at line 46 of file PRMGenerator_tpl.h.

                                                     {
      GUM_DESTRUCTOR(PRMGenerator);
    }

Member Function Documentation

generate()

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 >.

getNameGenerator()

template<typename GUM_SCALAR >

INLINE const NameGenerator & gum::prm::PRMGenerator< GUM_SCALAR >::getNameGenerator

(

)

const

Returns the NameGenerator used by this generator.

Definition at line 58 of file PRMGenerator_tpl.h.

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

                                                                    {
      return _name_gen;
    }

setNameGenerator()

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 51 of file PRMGenerator_tpl.h.

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

                                      {
      _name_gen = name_gen;
    }

Member Data Documentation

_name_gen

template<typename GUM_SCALAR >

NameGenerator gum::prm::PRMGenerator< GUM_SCALAR >::_name_gen

protected

The name generator used by this class.

Definition at line 81 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:

• agrum/PRM/generator/PRMGenerator.h
• agrum/PRM/generator/PRMGenerator_tpl.h