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 58 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 33 of file progressNotification.cpp.

References gum::Set< Key, Alloc >::emplace().

                                                            : _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 45 of file progressNotification.cpp.

References gum::Set< Key, Alloc >::emplace().

                                      {
    GUM_DESTRUCTOR(ProgressListener);
    ;
  }

Here is the call graph for this function:

ProgressListener() [2/2]

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

protected

Copy constructor.

Definition at line 40 of file progressNotification.cpp.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

Member Function Documentation

_attachSignal_()

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

inherited

Definition at line 35 of file listener_inl.h.

References gum::Set< Key, Alloc >::emplace().

{ _senders_.push_back(sender); }

Here is the call graph for this function:

_detachSignal_()

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

inherited

Definition at line 37 of file listener_inl.h.

References gum::Set< Key, Alloc >::emplace().

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

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

Here is the call graph for this function:

operator=()

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

protected

Copy operator.

Definition at line 50 of file progressNotification.cpp.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

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.

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.

Member Data Documentation

_notif_

ProgressNotifier& gum::ProgressListener::_notif_

private

The scheme configuration.

Definition at line 99 of file progressNotification.h.

---

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

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