progressNotification.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef AGRUM_PROGRESSNOTIFICATION_H
#define AGRUM_PROGRESSNOTIFICATION_H

#include <agrum/core/signal/signaler.h>
#include <agrum/core/timer.h>

namespace gum {

  class ProgressNotifier {
    public:
    Signaler2< Size, double > onProgress;

    Signaler1< const std::string& > onStop;
  };

  class ProgressListener : public Listener {
    public:
    explicit ProgressListener(ProgressNotifier& notif);

    virtual ~ProgressListener();

    virtual void
       whenProgress(const void* src, const Size step, const double time) = 0;

    virtual void whenStop(const void* src, const std::string& message) = 0;

    protected:
    ProgressListener(const ProgressListener& other);

    ProgressListener& operator=(const ProgressListener& other);

    private:
    ProgressNotifier& __notif;
  };
}   // namespace gum
#endif   // AGRUM_PROGRESSNOTIFICATION_H