gum::ProgressListener Class Reference

The ProgressListener class. More...

#include <progressNotification.h>

Inheritance diagram for gum::ProgressListener:

Collaboration diagram for gum::ProgressListener:

Public Member Functions
	ProgressListener (ProgressNotifier &notif)
	Class constructor. More...
virtual	~ProgressListener ()
	Class destructor. More...
virtual void	whenProgress (const void *src, const Size step, 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
	ProgressListener (const ProgressListener &other)
	Copy constructor. More...
ProgressListener &	operator= (const ProgressListener &other)
	Copy operator. More...

Detailed Description

The ProgressListener class.

Definition at line 59 of file progressNotification.h.

Constructor & Destructor Documentation

ProgressListener() [1/2]

gum::ProgressListener::ProgressListener ( ProgressNotifier &  notif )

explicit

Class constructor.

Parameters

the	progress notifier.

Definition at line 34 of file progressNotification.cpp.

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

                                                            : __notif(notif) {
    GUM_CONSTRUCTOR(ProgressListener);

    GUM_CONNECT((__notif), onProgress, (*this), ProgressListener::whenProgress);
    GUM_CONNECT((__notif), onStop, (*this), ProgressListener::whenStop);
  }

Here is the call graph for this function:

~ProgressListener()

gum::ProgressListener::~ProgressListener ( )

virtual

Class destructor.

Definition at line 47 of file progressNotification.cpp.

{ GUM_DESTRUCTOR(ProgressListener); }

ProgressListener() [2/2]

gum::ProgressListener::ProgressListener ( const ProgressListener &  other )

protected

Copy constructor.

Definition at line 41 of file progressNotification.cpp.

References GUM_ERROR.

                                                                  :
      __notif(other.__notif) {
    GUM_CONS_CPY(ProgressListener);
    GUM_ERROR(OperationNotAllowed, "No copy constructor for ProgressListener");
  }

Member Function Documentation

attachSignal__()

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

inherited

Definition at line 36 of file listener_inl.h.

References gum::Listener::__senders.

                                                               {
    __senders.push_back(sender);
  }

detachSignal__()

INLINE void gum::Listener::detachSignal__ ( __sig__::ISignaler *  sender )

inherited

Definition at line 40 of file listener_inl.h.

References gum::Listener::__senders.

                                                               {
    auto del = std::remove(__senders.begin(), __senders.end(), sender);

    if (del != __senders.end()) __senders.erase(del, __senders.end());
  }

operator=()

ProgressListener & gum::ProgressListener::operator= ( const ProgressListener &  other )

protected

Copy operator.

Definition at line 49 of file progressNotification.cpp.

References GUM_ERROR.

                                                                             {
    GUM_CONS_CPY(ProgressListener);
    GUM_ERROR(OperationNotAllowed, "No copy constructor for ProgressListener");
  }

whenProgress()

virtual void gum::ProgressListener::whenProgress ( const void *  src, const Size  step, const double  time  )

pure virtual

When progress was made.

Parameters

src	The signal source.
step	The advancement in percent.
time	The time.

Referenced by ProgressListener().

Here is the caller graph for this function:

whenStop()

virtual void gum::ProgressListener::whenStop ( const void *  src, const std::string &  message  )

pure virtual

When it stops.

Parameters

src	The signal source.
message	A message.

Referenced by ProgressListener().

Here is the caller graph for this function:

Member Data Documentation

__notif

ProgressNotifier& gum::ProgressListener::__notif

private

The scheme configuration.

Definition at line 101 of file progressNotification.h.

Referenced by ProgressListener().

---

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

• agrum/core/progressNotification.h
• agrum/core/progressNotification.cpp