dox/Testing/Rendering/vtkTesting.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkTesting.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef __vtkTesting_h
#define __vtkTesting_h

#include "vtkTestingRenderingModule.h" // For export macro
#include "vtkObject.h"
#include <vector> // STL Header used for argv
#include <string> // STL Header used for argv

class vtkAlgorithm;
class vtkRenderWindow;
class vtkImageData;
class vtkDataArray;
class vtkDataSet;
class vtkRenderWindowInteractor;

class VTKTESTINGRENDERING_EXPORT vtkTesting : public vtkObject
{
public:
  static vtkTesting *New();
  vtkTypeMacro(vtkTesting,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);

//BTX
  enum ReturnValue {
    FAILED = 0,
    PASSED = 1,
    NOT_RUN = 2,
    DO_INTERACTOR = 3
  };

  static int Test(int argc, char *argv[], vtkRenderWindow *rw, double thresh);


  static int InteractorEventLoop(int argc, char *argv[],
                                 vtkRenderWindowInteractor *iren,
                                 const char *stream = NULL);

//ETX


  vtkSetClampMacro(FrontBuffer, int, 0, 1);
  vtkBooleanMacro(FrontBuffer, int);
  vtkGetMacro(FrontBuffer, int);


  virtual int RegressionTest(double thresh);
  virtual int RegressionTest(double thresh,ostream &os);


  virtual int RegressionTest(const std::string &pngFileName, double thresh);
  virtual int RegressionTest(const std::string &pngFileName,
                             double thresh, ostream& os);


  virtual int RegressionTest(vtkAlgorithm* imageSource, double thresh);
  virtual int RegressionTest(vtkAlgorithm* imageSource, double thresh,
                             ostream& os);

  int CompareAverageOfL2Norm(vtkDataSet *pdA, vtkDataSet *pdB, double tol);

  int CompareAverageOfL2Norm(vtkDataArray *daA, vtkDataArray *daB, double tol);


  virtual void SetRenderWindow(vtkRenderWindow* rw);
  vtkGetObjectMacro(RenderWindow, vtkRenderWindow);


  vtkSetStringMacro(ValidImageFileName);
  const char *GetValidImageFileName();


  vtkGetMacro(ImageDifference, double);


  void AddArgument(const char *argv);
  void AddArguments(int argc,const char **argv);

  //BTX

  char *GetArgument(const char *arg);
  //ETX

  void CleanArguments();


  const char *GetDataRoot();
  vtkSetStringMacro(DataRoot);


  const char *GetTempDirectory();
  vtkSetStringMacro(TempDirectory);

  int IsValidImageSpecified();

  int IsInteractiveModeSpecified();

  int IsFlagSpecified(const char *flag);


  vtkSetMacro(BorderOffset, int);
  vtkGetMacro(BorderOffset, int);


  vtkSetMacro(Verbose, int);
  vtkGetMacro(Verbose, int);

protected:
  vtkTesting();
  ~vtkTesting();

  static char* IncrementFileName(const char* fname, int count);
  static int LookForFile(const char* newFileName);

  int FrontBuffer;
  vtkRenderWindow* RenderWindow;
  char* ValidImageFileName;
  double ImageDifference;
  char *TempDirectory;
  int BorderOffset;
  int Verbose;

//BTX
  std::vector<std::string> Args;
//ETX
  char *DataRoot;
  double StartWallTime;
  double StartCPUTime;

private:
  vtkTesting(const vtkTesting&);  // Not implemented.
  void operator=(const vtkTesting&);  // Not implemented.
};

#endif