aGrUM  0.13.2
gum::ApproximationSchemeListener Class Referenceabstract

The ApproximationSchemeListener class. More...

#include <approximationSchemeListener.h>

+ Inheritance diagram for gum::ApproximationSchemeListener:
+ Collaboration diagram for gum::ApproximationSchemeListener:

Public Member Functions

 ApproximationSchemeListener (IApproximationSchemeConfiguration &sch)
 Class constructor. More...
 
virtual ~ApproximationSchemeListener ()
 Class destructor. More...
 
virtual void whenProgress (const void *src, const Size step, const double error, const double time)=0
 When progress was made. More...
 
virtual void whenStop (const void *src, const std::string message)=0
 When it stops. More...
 
void attachSignal__ (__sig__::ISignaler *sender)
 
void detachSignal__ (__sig__::ISignaler *sender)
 

Protected Member Functions

 ApproximationSchemeListener (const ApproximationSchemeListener &other)
 Copy constructor. More...
 
ApproximationSchemeListeneroperator= (const ApproximationSchemeListener &other)
 Copy operator. More...
 

Detailed Description

The ApproximationSchemeListener class.

Warning
Doxygen does not like spanning command on multiple line, so we could not configure it with the correct include directive. Use the following code snippet to include this file.

Definition at line 48 of file approximationSchemeListener.h.

Constructor & Destructor Documentation

gum::ApproximationSchemeListener::ApproximationSchemeListener ( IApproximationSchemeConfiguration sch)

Class constructor.

Parameters
schThe scheme configuration.

Definition at line 31 of file approximationSchemeListener.cpp.

References __sch, GUM_CONNECT, whenProgress(), and whenStop().

32  :
33  __sch(sch) {
34  GUM_CONSTRUCTOR(ApproximationSchemeListener);
35 
37  (__sch), onProgress, (*this), ApproximationSchemeListener::whenProgress);
39  }
virtual void whenStop(const void *src, const std::string message)=0
When it stops.
ApproximationSchemeListener(IApproximationSchemeConfiguration &sch)
Class constructor.
#define GUM_CONNECT(sender, signal, receiver, target)
Definition: listener.h:96
IApproximationSchemeConfiguration & __sch
The scheme configuration.
virtual void whenProgress(const void *src, const Size step, const double error, const double time)=0
When progress was made.

+ Here is the call graph for this function:

gum::ApproximationSchemeListener::~ApproximationSchemeListener ( )
virtual

Class destructor.

Definition at line 49 of file approximationSchemeListener.cpp.

References operator=().

49  {
50  GUM_DESTRUCTOR(ApproximationSchemeListener);
51  }
ApproximationSchemeListener(IApproximationSchemeConfiguration &sch)
Class constructor.

+ Here is the call graph for this function:

gum::ApproximationSchemeListener::ApproximationSchemeListener ( const ApproximationSchemeListener other)
protected

Copy constructor.

Definition at line 41 of file approximationSchemeListener.cpp.

References GUM_ERROR.

42  :
43  __sch(other.__sch) {
44  GUM_CONS_CPY(ApproximationSchemeListener);
45  GUM_ERROR(OperationNotAllowed,
46  "No copy constructor for ApproximationSchemeListener");
47  }
ApproximationSchemeListener(IApproximationSchemeConfiguration &sch)
Class constructor.
IApproximationSchemeConfiguration & __sch
The scheme configuration.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66

Member Function Documentation

INLINE void gum::Listener::attachSignal__ ( __sig__::ISignaler *  sender)
inherited

Definition at line 33 of file listener_inl.h.

References gum::Listener::__senders.

33  {
34  __senders.push_back(sender);
35  }
Senders_list __senders
Definition: listener.h:92
INLINE void gum::Listener::detachSignal__ ( __sig__::ISignaler *  sender)
inherited

Definition at line 37 of file listener_inl.h.

References gum::Listener::__senders.

37  {
38  auto del = std::remove(__senders.begin(), __senders.end(), sender);
39 
40  if (del != __senders.end()) __senders.erase(del, __senders.end());
41  }
Senders_list __senders
Definition: listener.h:92
ApproximationSchemeListener & gum::ApproximationSchemeListener::operator= ( const ApproximationSchemeListener other)
protected

Copy operator.

Definition at line 54 of file approximationSchemeListener.cpp.

References GUM_ERROR.

Referenced by ~ApproximationSchemeListener().

54  {
55  GUM_CONS_CPY(ApproximationSchemeListener);
56  GUM_ERROR(OperationNotAllowed,
57  "No copy constructor for ApproximationSchemeListener");
58  }
ApproximationSchemeListener(IApproximationSchemeConfiguration &sch)
Class constructor.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:66

+ Here is the caller graph for this function:

virtual void gum::ApproximationSchemeListener::whenProgress ( const void *  src,
const Size  step,
const double  error,
const double  time 
)
pure virtual

When progress was made.

Parameters
srcThe signal source.
pourcentThe advancement in percent.
errorThe number of errors.
timeThe time.

Implemented in gum::learning::BNLearnerListener.

Referenced by ApproximationSchemeListener().

+ Here is the caller graph for this function:

virtual void gum::ApproximationSchemeListener::whenStop ( const void *  src,
const std::string  message 
)
pure virtual

When it stops.

Parameters
srcThe signal source.
messageA message.

Implemented in gum::learning::BNLearnerListener.

Referenced by ApproximationSchemeListener().

+ Here is the caller graph for this function:

Member Data Documentation

IApproximationSchemeConfiguration& gum::ApproximationSchemeListener::__sch
private

The scheme configuration.

Definition at line 94 of file approximationSchemeListener.h.

Referenced by ApproximationSchemeListener().


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