src/core/qgsrenderchecker.h

Go to the documentation of this file.

/***************************************************************************
     qgsrenderchecker.h - check maprender output against an expected image
                     --------------------------------------
               Date                 : 18 Jan 2008
               Copyright            : (C) 2008 by Tim Sutton
               email                : 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.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef QGSRENDERCHECKER_H
#define QGSRENDERCHECKER_H

#include <QDir>
#include <QString>
#include <qgsmaprenderer.h>
class QImage;

class CORE_EXPORT QgsRenderChecker
{
  public:

    QgsRenderChecker();

    ~QgsRenderChecker() {};

    QString controlImagePath() const;

    QString report() { return mReport; };
    float matchPercent()
    {
      return static_cast<float>( mMismatchCount ) /
             static_cast<float>( mMatchTarget ) * 100;
    };
    unsigned int mismatchCount() { return mMismatchCount; };
    unsigned int matchTarget() { return mMatchTarget; };
    //only records time for actual render part
    int elapsedTime() { return mElapsedTime; };
    void setElapsedTimeTarget( int theTarget ) { mElapsedTimeTarget = theTarget; };
    void setControlName( const QString theName );
    void setControlPathPrefix( const QString theName ) { mControlPathPrefix = theName + QDir::separator(); }
    QString imageToHash( QString theImageFile );

    void setRenderedImage( QString theImageFileName ) { mRenderedImageFile = theImageFileName; };
    void setMapRenderer( QgsMapRenderer *  thepMapRenderer ) { mpMapRenderer = thepMapRenderer; };
    bool runTest( QString theTestName, unsigned int theMismatchCount = 0 );

    bool compareImages( QString theTestName, unsigned int theMismatchCount = 0, QString theRenderedImageFile = "" );
    bool isKnownAnomaly( QString theDiffImageFile );

  private:

    QString mReport;
    QString mExpectedImageFile;
    QString mControlName;
    QString mRenderedImageFile;
    unsigned int mMismatchCount;
    unsigned int mMatchTarget;
    int mElapsedTime;
    int mElapsedTimeTarget;
    QgsMapRenderer * mpMapRenderer;
    QString mControlPathPrefix;

}; // class QgsRenderChecker

#endif