omgexperiment.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Tim Sutton   *
 *   tim@linfiniti.com   *
 *                                                                         *
 *   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 OMGEXPERIMENT_H
#define OMGEXPERIMENT_H

#include "omgmodel.h"
#include "omgmodellerplugininterface.h"
#include "omgserialisable.h"
#include "omgguid.h"

//qt includes
#include <QVector>
#include <QList>
#include <QObject>
#include <QMap>
#include <QMutex>
#include <QThread>
#include <QWaitCondition>

class OMG_LIB_EXPORT OmgExperiment : public QThread, public OmgSerialisable, public OmgGuid
{
  Q_OBJECT;

public:
  OmgExperiment();
  ~OmgExperiment();
  QString name();
  void setName(QString theName);
  QString description();
  void setDescription(QString theDescription);
  QString workDir();
  void setWorkDir(QString theWorkDir);
  QString currentStatus() {return mCurrentStatus;};
  void reset();
  bool isRunning();
  void addModel(OmgModel  * thepModel) ;
  OmgModel * getModel(int theModelNo);
  OmgModel * getModel(QString theGuid);
  void run();
  void stop();
  int count();
  void clear() ;
  void removeModel(QString theGuid);
  void removeAlgorithm(QString theName);
  void removeTaxon(QString theName);
  void removeCompleted() ;
  OmgModellerPluginInterface * modellerPlugin();
  void setModellerPlugin(OmgModellerPluginInterface * theAdapter);
  const QString toString();
  bool isAborted();
  QString toSummaryHtml(bool theForceFlag=false);
  QString toPrintHtml(bool theForceFlag=false);
  QString toAlgorithmSummaryHtml(QString theAlgorithmName,bool theForceFlag=false);
  QString toTaxonSummaryHtml(QString theTaxonName,bool theForceFlag=false);
  void makeAlgorithmSummaryGraphs(QString theWorkDir); 
  
  void save();
  
  //
  // implement the serialisable interface:
  //

  QString toXml() const ;
  bool fromXml(const QString theXml) ;

public slots:
  void abort();
signals:
  void experimentMaximum(int);
  void experimentProgress(int);
  void modelCreationProgress(int);
  void modelProjectionProgress(int);
  void logMessage(QString);
  void experimentStopped();
  void modelCompleted(QString);
private:
  QString getStatsHtml();
  QString getGraphsHtml(QString theImagePrefix ="", bool theForceFlag =false);
  void addValueToSummaryGraph(
    QMap<QString,QList <double > > & theMap,
    QString theAlgorithmName,
    double theValue); 
  void summaryMapToGraph( QMap<QString,QList < double > > &theMap, 
           QString theWorkDir, 
           QString theImageSuffix );

  //
  //
  //  Members ...
  //
  //
  QMutex mMutex;
  QWaitCondition mCondition;
  QString mName;
  QString mDescription;
  QVector <OmgModel * > mModelVector;
  int mLastPos;
  OmgModellerPluginInterface * mpModellerPlugin;
  bool mAbortFlag;
  QString mWorkDir;
  QString mCurrentStatus;
  bool mRunningFlag;
};

#endif //OMGEXPERIMENT_H

---