evonetui.cpp

/********************************************************************************
 *  FARSA Experiments Library                                                   *
 *  Copyright (C) 2007-2012                                                     *
 *  Stefano Nolfi <stefano.nolfi@istc.cnr.it>                                   *
 *  Onofrio Gigliotta <onofrio.gigliotta@istc.cnr.it>                           *
 *  Gianluca Massera <emmegian@yahoo.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  *
 ********************************************************************************/

#include "evonetui.h"
#include "displaycontroller.h"
#include "evodataviewer.h"
#include "holisticviewer.h"
#include "total99resources.h"
#include <QGridLayout>
#include <QPushButton>
#include <QCheckBox>
#include <QFileDialog>
#include <QVBoxLayout>
#include <QDir>
#include <QFileInfo>
#include <QFile>
#include <QEvent>
#include <QCoreApplication>
#include <QTimer>

// All the suff below is to avoid warnings on Windows about the use of unsafe
// functions. This should be only a temporary workaround, the solution is stop
// using C string and file functions...
#if defined(_MSC_VER)
    #pragma warning(push)
    #pragma warning(disable:4996)
#endif

namespace farsa {

EvonetUI::EvonetUI( Evonet* evonet )
    : QObject(), ParameterSettableUI() {
    this->evonet = evonet;

    // Global connections
    // !! DO NOT CONNECT TO THE evonetUpdated SIGNAL to update the network becuase that signals may be
    //    emitted so fast that the GUI will freeze !!
    //connect( evonet, SIGNAL(evonetUpdated()), this, SLOT(onEvonetUpdated()), Qt::QueuedConnection );
    QTimer* timer = new QTimer(this);
    timer->setInterval( 40 );
    timer->setSingleShot( false );
    timer->start();
    connect( timer, SIGNAL(timeout()), this, SLOT(onEvonetUpdated()) );
}

EvonetUI::~EvonetUI()
{
    // Nothing to do
    // --- All objects are destroyed in others parts because none of them are owend by this object
}

QList<ParameterSettableUIViewer> EvonetUI::getViewers( QWidget* parent, Qt::WindowFlags flags ) {
    QList<ParameterSettableUIViewer> viewsList;
    viewsList.append( networkView( parent, flags ) );
    viewsList.append( neuroMonitorView( parent, flags ) );
    viewsList.append( holisticView( parent, flags ) );
    return viewsList;
}

ParameterSettableUIViewer EvonetUI::networkView( QWidget* parent, Qt::WindowFlags flags )
{
    networkDialog = new NetworkDialog(evonet,parent,flags);
    networkDialog->pseudo_activate_net();
    networkDialog->setWindowTitle( "Neural Network Editor" );
    return ParameterSettableUIViewer( networkDialog, "Nervous System" );
}

ParameterSettableUIViewer EvonetUI::neuroMonitorView( QWidget* parent, Qt::WindowFlags flags )
{
    edv = new EvoDataViewer( evonet->getNoNeurons(), 1000, 0, parent, flags );

    //setting chunk properties
    bool dn;
    for (int i = 0; i < evonet->getNoNeurons(); i++) {
        if (evonet->neurondisplay[i] == 1) {
            dn = true;
        } else {
            dn = false;
        }
        if ( evonet->neurondcolor[i].isValid() ) {
            edv->setChunkProperties(i, evonet->neuronrange[i][0], evonet->neuronrange[i][1], evonet->neuronl[i], evonet->neurondcolor[i], dn);
        } else {
            // if the color is not valid, will use the color red
            edv->setChunkProperties(i, evonet->neuronrange[i][0], evonet->neuronrange[i][1], evonet->neuronl[i], QColor(255,0,0), dn);
        }
    }
    edv->setWindowTitle( "Neurons Monitor" );
    edv->setGeometry(50, 50, 600, 600);
    return ParameterSettableUIViewer( edv, "Neurons Monitor" );
}

ParameterSettableUIViewer EvonetUI::holisticView( QWidget* parent, Qt::WindowFlags flags )
{
    hlv = new HolisticViewer(evonet, parent, flags);
    hlv->resize(300, 300);
    hlv->setWindowTitle("Holistic Viewer");
    return ParameterSettableUIViewer( hlv, "Holistic View" );
}

void EvonetUI::onEvonetUpdated() {
    // updating the Newtork Dialog
    if ( networkDialog ) {
        networkDialog->update();
    }
    // updating EvoDataViewer
    if ( edv ) {
        float *acts;
        
        // FIXME: the getOldestStoredActivations return only one value of a circual buffer
        //        of stored activations that it's continously filled by Evonet
        //     !! In the case on which the Evonet is updated too fast respect to the velocity
        //        of consuming the values on the buffer, the GUI will cycle forever trying to
        //        consume all oldest activations. !!
        //
        //        The best solution would be to use the ResourceLocker to lock on the Evonet but
        //        at the moment of comment writing this is not possible because to use ResourceLocker
        //        we should know who is the ResourceUsers with shareResourcesWith in order to use the
        //        lock and to use the getResource method.
        //        But because we planned to put into each ParameterSettable an attribute storing the
        //        ConfigurationParameter used for configuring it, and to also put inside the ConfigurationParameter
        //        an attribute for storing all Resources declared during the configuration,
        //        the complete solution of this problem is postponed to above planned modification.
        //        In fact, after that modification, it would be possible to shareResourceWith the ConfigurationParameter
        //        used for configure the Evonet and then use the ResourceLocker.
        //
        //        For now, we simple add a safe break to avoid to cycle forever, but it means that the data
        //        might be displayed wrongly.
        int counter = 0;
        do {
            acts = evonet->getOldestStoredActivations();
            if (acts != NULL) {
                counter++;
                for (int ch = 0; ch < evonet->getNoNeurons(); ch++) {
                    edv->setChunkValue(ch, acts[ch]);
                }
            }
        } while (acts != NULL && counter<Evonet::MAXSTOREDACTIVATIONS);
        edv->setCurrentStep( evonet->updateCounts() );
        edv->update();
    }
    // updating holistic viewer
    if ( hlv ) {
        hlv->updateGrid();
        hlv->updatePlot();
        hlv->update();
    }
}

} //end namespace farsa

// All the suff below is to restore the warning state on Windows
#if defined(_MSC_VER)
    #pragma warning(pop)
#endif