omgmodel.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 OMGMODEL_H
#define OMGMODEL_H

#include <QString>
#include <QStringList>
#include <QDateTime>
#include <QFile>
#include <QVector>
#include <QList>
#include <QPair>
#include "omgalgorithm.h"
#include "omglocality.h"
#include "omgserialisable.h"
#include "omglayerset.h"
#include "omglayer.h"
#include "omgguid.h"
#include "omgdataseries.h"

class OMG_LIB_EXPORT OmgModel : public QObject, public OmgSerialisable, public OmgGuid
{

  Q_OBJECT; //needed for QPointer guarded pointer support
public:

  OmgModel();
  ~OmgModel();
  enum LocalitiesFilterType {NO_FILTER,SPATIALLY_UNIQUE,ENVIRONMENTALLY_UNIQUE};
  bool isValid() const;
  QString toString() const;
  QString toHtml(bool theForceFlag=false) const;
  QString toPrintHtml(bool theForceFlag=false) const ;
  void createRocGraph(bool theForceFlag=false) const;
  QString projectionLayersXml() ;
  void reset();
  bool  parseModelResult(QString theModelXml);

  //mutators
  void setCoordinateSystem(QString theCoordinateSystem);
  void setCoordinateSystemName (QString theName);
  void setOccurrencesFile(QString theSpeciesFile);
  void setSpeciesFile(QString theFileName );
  void setShapefileName(QString theFileName);
  void setCsvFileName(QString theFileName);
  void setTaxonName(QString theName);
  void setLocalities(OmgLocalities theLocalities);
  void setOutputFormatLayerName(QString theName);
 
  void setModelRasterFormat(QString theFormat);
  void setCreationLayerSet(OmgLayerSet theLayerSet);
  void setProjectionLayerSet(OmgLayerSet theLayerSet);
  
  //
  // The following four mutators will be deprecated in favour of the above
  //
  
  void setCreationLayerNames(QStringList theNames);
  void setcreationMaskLayerName(QString theName);
  void setProjectionLayerNames(QStringList theNames);
  void setProjectionMaskLayerName(QString theName);
  
  void setAlgorithm(OmgAlgorithm theAlgorithm);
  void setCompleted(bool theFlag);
  void setError(bool theFlag);
  void setStartDateTimeStamp(QDateTime theDateTimeStamp);
  void setEndDateTimeStamp(QDateTime theDateTimeStamp);
  void setThumbnailFileName(QString theFileName);
  void setPreviewFileName(QString theFileName);
  void setLegendFileName(QString theFileName);
  void setRawImageFileName(QString theFileName);
  void setColouredImageFileName(QString theFileName);
  void setWorkDir(QString theDir);
  void setModelDefinition(QString theDefinition);
  void setNormalizationDefinition(QString theDefinition);
  void setRocScore(double theRocScore);
  void setAccuracy(double theAccuracy);
  void setOmission(double theOmission);
  void setCommission(double theCommission);
  void setPercentCellsPresent(double thePercent );
  void setTotalCells(double theTotal);
  void setLocalitiesFilterType(LocalitiesFilterType theFilterType=NO_FILTER);
  
  //accessors
 
  QString coordinateSystem() const;
  QString coordinateSystemName() const;
  QString speciesFile() const;
  QString shapefileName() const;
  QString csvFileName() const;
  QString taxonName() const;
  OmgLayerSet creationLayerSet() const;
  OmgLayerSet projectionLayerSet() const;
  QString creationMaskLayerName() const;
  QString projectionMaskLayerName() const;
  QString outputFormatLayerName() const;
  QStringList creationLayerNames() const;
  QStringList projectionLayerNames() const;
  OmgAlgorithm algorithm() const;
  bool isCompleted() const;
  bool hasError() const;
  QDateTime startDateTimeStamp() const;
  QDateTime endDateTimeStamp() const;
  QString thumbnailFileName() const;
  QString previewFileName() const;
  QString legendFileName() const;
  QString rawImageFileName() const;
  QString colouredImageFileName() const;
  QString modelRasterFormat() const;

  QString workDir() const;
  double rocScore() const;
  double accuracy() const;
  double omission() const;
  double commission() const;
  double percentCellsPresent() const;
  double totalCells() const;
  QString modelDefinition() const;
  QString normalizationDefinition() const;
  LocalitiesFilterType localitiesFilterType() const;
  OmgLocalities localities() const;
  QString modelLog() const;
  //
  // General helper functions
  //
  unsigned int loadLocalities();

  void createThumbnail();
  //
  // implement the serialisable interface:
  //

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

  QString toModelCreationXml() const;
  
  QString toModelProjectionXml() const;

  QString localitiesToCsv(QString theDelimiter="\t") const;

  bool toShapefile(QString theShapefileName) const;

  void addRocPoint( QPair <double,double> thePair );
  void clearRocPoints();
  OmgDataSeries getRocPoints() const;
  bool postProcess();

 public slots:
  void appendToLog(QString theMessage);
  void setLog(QString theLog);
private:

  QString mCoordinateSystem;
  QString mCoordinateSystemName;
  QString mSpeciesFile;
  QString mTaxonName;
  OmgLayer mOutputFormatLayer;
  OmgLayerSet mProjectionLayerSet;
  OmgLayerSet mCreationLayerSet;
  OmgAlgorithm mAlgorithm;
  bool mCompletedFlag;
  bool mErrorFlag;
  //this type is defined at the bottom of omglocality.h
  OmgLocalities mLocalities;
  QDateTime mStartDateTimeStamp;
  QDateTime mEndDateTimeStamp;
  QString mThumbnailFileName;
  QString mPreviewFileName;
  QString mLegendFileName;
  QString mRawImageFileName;
  QString mShapefileName;
  QString mCsvFileName;
  QString mColouredImageFileName;
  QString mWorkDir;
  QString mModelDefinition;
  QString mNormalizationDefinition;
  double mRocScore;
  double mAccuracy;
  double mOmission;
  double mCommission;
  double mPercentCellsPresent;
  double mTotalCells;
  QString mModelLog;
  QList < QPair <double,double> > mRocPoints;
  QString mModelRasterFormat;
  LocalitiesFilterType  mLocalitiesFilterType;
};

#endif //OMGMODEL_H

---