flowcontrol.h

/********************************************************************************
 *  FARSA                                                                       *
 *  Copyright (C) 2007-2012                                                     *
 *  Gianluca Massera <emmegian@yahoo.it>                                        *
 *  Stefano Nolfi <stefano.nolfi@istc.cnr.it>                                   *
 *  Tomassino Ferrauto <tomassino.ferrauto@istc.cnr.it>                         *
 *                                                                              *
 *  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., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA  *
 ********************************************************************************/

#ifndef FLOWCONTROL_H
#define FLOWCONTROL_H

#include "experimentsconfig.h"

namespace farsa {

class FARSA_EXPERIMENTS_TEMPLATE FlowController
{
public:
    virtual bool stop() = 0;

    virtual void pause() = 0;
};

class FARSA_EXPERIMENTS_TEMPLATE DummyFlowController : public FlowController
{
public:
    virtual bool stop()
    {
        return false;
    }

    virtual void pause()
    {
    }
};

#if defined(__GNUC__) && defined(DEVELOPER_WARNINGS)
    #warning forse in farsa 2 questa roba si può mettere nella classe Component che ha una struttura gerarchica, in modo da propagare automaticamente il flow controller ai figli. In tal caso la funzione flowControllerChanged può essere forse rimossa
#endif
class FARSA_EXPERIMENTS_TEMPLATE FlowControlled
{
public:
    FlowControlled()
        : m_dummyFlowController()
        , m_flowController(&m_dummyFlowController)
    {
    }

    FlowControlled(FlowController* flowController)
        : m_dummyFlowController()
        , m_flowController((flowController == NULL) ? &m_dummyFlowController : flowController)
    {
    }

    void setFlowController(FlowController* flowController)
    {
        if (flowController != m_flowController) {
            if (flowController == NULL) {
                m_flowController = &m_dummyFlowController;
            } else {
                m_flowController = flowController;
            }

            flowControllerChanged(m_flowController);
        }
    }

protected:
    bool stopFlow()
    {
        return m_flowController->stop();
    }

    void pauseFlow()
    {
        m_flowController->pause();
    }

    virtual void flowControllerChanged(FlowController* flowController)
    {
        Q_UNUSED(flowController)
    }

private:
    DummyFlowController m_dummyFlowController;

    FlowController* m_flowController;
};

}

#endif