ActiViz .NET  5.8.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkTesting Class Reference

vtkTesting - a unified VTK regression testing framework More...

Inheritance diagram for Kitware.VTK.vtkTesting:
[legend]
Collaboration diagram for Kitware.VTK.vtkTesting:
[legend]

List of all members.

Public Types

enum  ReturnValue { DO_INTERACTOR = 3, FAILED = 0, NOT_RUN = 2, PASSED = 1 }
 Undocumented Block. More...

Public Member Functions

 vtkTesting (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkTesting ()
 Undocumented Block.
void AddArgument (string argv)
 Pass the command line arguments into this class to be processed. Many of the Get methods such as GetValidImage and GetBaselineRoot rely on the arguments to be passed in prior to retrieving these values. Just call AddArgument for each argument that was passed into the command line.
void AddArguments (string[] argv)
 Pass the command line arguments into this class to be processed. Many of the Get methods such as GetValidImage and GetBaselineRoot rely on the arguments to be passed in prior to retrieving these values. Just call AddArgument for each argument that was passed into the command line.
void CleanArguments ()
 Description This method delete all arguments in vtkTesting, this way you can reuse it in a loop where you would have multiple testing.
int CompareAverageOfL2Norm (vtkDataSet pdA, vtkDataSet pdB, double tol)
 Compute the average L2 norm between all point data data arrays of types float and double present in the data sets "dsA" and "dsB" (this includes instances of vtkPoints) Compare the result of each L2 comutation to "tol".
int CompareAverageOfL2Norm (vtkDataArray daA, vtkDataArray daB, double tol)
 Compute the average L2 norm between two data arrays "daA" and "daB" and compare against "tol".
virtual void FrontBufferOff ()
 Use front buffer for tests. By default use back buffer.
virtual void FrontBufferOn ()
 Use front buffer for tests. By default use back buffer.
string GetArgument (string arg)
 Pass the command line arguments into this class to be processed. Many of the Get methods such as GetValidImage and GetBaselineRoot rely on the arguments to be passed in prior to retrieving these values. Just call AddArgument for each argument that was passed into the command line.
virtual int GetBorderOffset ()
 Number of pixels added as borders to avoid problems with window decorations added by some window managers.
string GetDataRoot ()
 Get some parameters from the command line arguments, env, or defaults.
virtual int GetFrontBuffer ()
 Use front buffer for tests. By default use back buffer.
virtual int GetFrontBufferMaxValue ()
 Use front buffer for tests. By default use back buffer.
virtual int GetFrontBufferMinValue ()
 Use front buffer for tests. By default use back buffer.
virtual double GetImageDifference ()
 Get the image difference.
virtual vtkRenderWindow GetRenderWindow ()
 Set and get the render window that will be used for regression testing.
string GetTempDirectory ()
 Get some parameters from the command line arguments, env, or defaults.
string GetValidImageFileName ()
 Set/Get the name of the valid image file.
virtual int GetVerbose ()
 Get/Set verbosity level. A level of 0 is quiet.
override int IsA (string type)
 Undocumented Block.
int IsFlagSpecified (string flag)
 Is some arbitrary user flag ("-X", "-Z" etc) specified.
int IsInteractiveModeSpecified ()
 Is the interactive mode specified?
int IsValidImageSpecified ()
 Is a valid image specified on the command line areguments?
new vtkTesting NewInstance ()
 Undocumented Block.
virtual int RegressionTest (double thresh)
 Perform the test and return result. At the same time the output will be written cout.
virtual int RegressionTest (vtkImageData image, double thresh)
 Compare the image with the valid image.
virtual void SetBorderOffset (int _arg)
 Number of pixels added as borders to avoid problems with window decorations added by some window managers.
virtual void SetDataRoot (string _arg)
 Get some parameters from the command line arguments, env, or defaults.
virtual void SetFrontBuffer (int _arg)
 Use front buffer for tests. By default use back buffer.
virtual void SetRenderWindow (vtkRenderWindow rw)
 Set and get the render window that will be used for regression testing.
virtual void SetTempDirectory (string _arg)
 Get some parameters from the command line arguments, env, or defaults.
virtual void SetValidImageFileName (string _arg)
 Set/Get the name of the valid image file.
virtual void SetVerbose (int _arg)
 Get/Set verbosity level. A level of 0 is quiet.

Static Public Member Functions

static new vtkTesting New ()
 Undocumented Block.
static int InteractorEventLoop (string[] argv, vtkRenderWindowInteractor iren, string stream)
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkTesting SafeDownCast (vtkObjectBase o)
 Undocumented Block.
static int Test (string[] argv, vtkRenderWindow rw, double thresh)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkTesting"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "10vtkTesting"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkTesting_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTesting_AddArgument_01 (HandleRef pThis, string argv)
static internal void vtkTesting_AddArguments_02 (HandleRef pThis, int argc,[In, Out] string[] argv)
static internal void vtkTesting_CleanArguments_03 (HandleRef pThis)
static internal int vtkTesting_CompareAverageOfL2Norm_04 (HandleRef pThis, HandleRef pdA, HandleRef pdB, double tol)
static internal int vtkTesting_CompareAverageOfL2Norm_05 (HandleRef pThis, HandleRef daA, HandleRef daB, double tol)
static internal void vtkTesting_FrontBufferOff_06 (HandleRef pThis)
static internal void vtkTesting_FrontBufferOn_07 (HandleRef pThis)
static internal IntPtr vtkTesting_GetArgument_08 (HandleRef pThis, string arg)
static internal int vtkTesting_GetBorderOffset_09 (HandleRef pThis)
static internal IntPtr vtkTesting_GetDataRoot_10 (HandleRef pThis)
static internal int vtkTesting_GetFrontBuffer_11 (HandleRef pThis)
static internal int vtkTesting_GetFrontBufferMaxValue_12 (HandleRef pThis)
static internal int vtkTesting_GetFrontBufferMinValue_13 (HandleRef pThis)
static internal double vtkTesting_GetImageDifference_14 (HandleRef pThis)
static internal IntPtr vtkTesting_GetRenderWindow_15 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkTesting_GetTempDirectory_16 (HandleRef pThis)
static internal IntPtr vtkTesting_GetValidImageFileName_17 (HandleRef pThis)
static internal int vtkTesting_GetVerbose_18 (HandleRef pThis)
static internal int vtkTesting_InteractorEventLoop_19 (int argc,[In, Out] string[] argv, HandleRef iren, string stream)
static internal int vtkTesting_IsA_20 (HandleRef pThis, string type)
static internal int vtkTesting_IsFlagSpecified_21 (HandleRef pThis, string flag)
static internal int vtkTesting_IsInteractiveModeSpecified_22 (HandleRef pThis)
static internal int vtkTesting_IsTypeOf_23 (string type)
static internal int vtkTesting_IsValidImageSpecified_24 (HandleRef pThis)
static internal IntPtr vtkTesting_NewInstance_26 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkTesting_RegressionTest_27 (HandleRef pThis, double thresh)
static internal int vtkTesting_RegressionTest_28 (HandleRef pThis, HandleRef image, double thresh)
static internal IntPtr vtkTesting_SafeDownCast_29 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTesting_SetBorderOffset_30 (HandleRef pThis, int _arg)
static internal void vtkTesting_SetDataRoot_31 (HandleRef pThis, string _arg)
static internal void vtkTesting_SetFrontBuffer_32 (HandleRef pThis, int _arg)
static internal void vtkTesting_SetRenderWindow_33 (HandleRef pThis, HandleRef rw)
static internal void vtkTesting_SetTempDirectory_34 (HandleRef pThis, string _arg)
static internal void vtkTesting_SetValidImageFileName_35 (HandleRef pThis, string _arg)
static internal void vtkTesting_SetVerbose_36 (HandleRef pThis, int _arg)
static internal int vtkTesting_Test_37 (int argc,[In, Out] string[] argv, HandleRef rw, double thresh)

Static Private Member Functions

static vtkTesting ()
 Automatically generated type registration mechanics.

Detailed Description

vtkTesting - a unified VTK regression testing framework

Description

This is a VTK regression testing framework. Looks like this:

vtkTesting* t = vtkTesting::New();

Two options for setting arguments

Option 1: for ( cc = 1; cc < argc; cc ++ ) { t->AddArgument(argv[cc]); }

Option 2: t->AddArgument("-D"); t->AddArgument(my_data_dir); t->AddArgument("-V"); t->AddArgument(my_valid_image);

...

Two options of doing testing:

Option 1: t->SetRenderWindow(renWin); int res = t->RegressionTest(threshold);

Option 2: int res = t->RegressionTest(test_image, threshold);

...

if ( res == vtkTesting::PASSED ) { Test passed } else { Test failed }


Member Enumeration Documentation

Undocumented Block.

Enumerator:
DO_INTERACTOR 

enum member

FAILED 

enum member

NOT_RUN 

enum member

PASSED 

enum member


Constructor & Destructor Documentation

static Kitware.VTK.vtkTesting.vtkTesting ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkTesting.vtkTesting ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

void Kitware.VTK.vtkTesting.AddArgument ( string  argv)

Pass the command line arguments into this class to be processed. Many of the Get methods such as GetValidImage and GetBaselineRoot rely on the arguments to be passed in prior to retrieving these values. Just call AddArgument for each argument that was passed into the command line.

void Kitware.VTK.vtkTesting.AddArguments ( string[]  argv)

Pass the command line arguments into this class to be processed. Many of the Get methods such as GetValidImage and GetBaselineRoot rely on the arguments to be passed in prior to retrieving these values. Just call AddArgument for each argument that was passed into the command line.

Description This method delete all arguments in vtkTesting, this way you can reuse it in a loop where you would have multiple testing.

Compute the average L2 norm between all point data data arrays of types float and double present in the data sets "dsA" and "dsB" (this includes instances of vtkPoints) Compare the result of each L2 comutation to "tol".

Compute the average L2 norm between two data arrays "daA" and "daB" and compare against "tol".

override void Kitware.VTK.vtkTesting.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkObject.

virtual void Kitware.VTK.vtkTesting.FrontBufferOff ( ) [virtual]

Use front buffer for tests. By default use back buffer.

virtual void Kitware.VTK.vtkTesting.FrontBufferOn ( ) [virtual]

Use front buffer for tests. By default use back buffer.

string Kitware.VTK.vtkTesting.GetArgument ( string  arg)

Pass the command line arguments into this class to be processed. Many of the Get methods such as GetValidImage and GetBaselineRoot rely on the arguments to be passed in prior to retrieving these values. Just call AddArgument for each argument that was passed into the command line.

virtual int Kitware.VTK.vtkTesting.GetBorderOffset ( ) [virtual]

Number of pixels added as borders to avoid problems with window decorations added by some window managers.

Get some parameters from the command line arguments, env, or defaults.

virtual int Kitware.VTK.vtkTesting.GetFrontBuffer ( ) [virtual]

Use front buffer for tests. By default use back buffer.

Use front buffer for tests. By default use back buffer.

Use front buffer for tests. By default use back buffer.

virtual double Kitware.VTK.vtkTesting.GetImageDifference ( ) [virtual]

Get the image difference.

Set and get the render window that will be used for regression testing.

Here is the call graph for this function:

Get some parameters from the command line arguments, env, or defaults.

Set/Get the name of the valid image file.

virtual int Kitware.VTK.vtkTesting.GetVerbose ( ) [virtual]

Get/Set verbosity level. A level of 0 is quiet.

static int Kitware.VTK.vtkTesting.InteractorEventLoop ( string[]  argv,
vtkRenderWindowInteractor  iren,
string  stream 
) [static]

Undocumented Block.

override int Kitware.VTK.vtkTesting.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Is some arbitrary user flag ("-X", "-Z" etc) specified.

Is the interactive mode specified?

static new int Kitware.VTK.vtkTesting.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Is a valid image specified on the command line areguments?

static new vtkTesting Kitware.VTK.vtkTesting.New ( ) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

virtual int Kitware.VTK.vtkTesting.RegressionTest ( double  thresh) [virtual]

Perform the test and return result. At the same time the output will be written cout.

virtual int Kitware.VTK.vtkTesting.RegressionTest ( vtkImageData  image,
double  thresh 
) [virtual]

Compare the image with the valid image.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkTesting.SetBorderOffset ( int  _arg) [virtual]

Number of pixels added as borders to avoid problems with window decorations added by some window managers.

virtual void Kitware.VTK.vtkTesting.SetDataRoot ( string  _arg) [virtual]

Get some parameters from the command line arguments, env, or defaults.

virtual void Kitware.VTK.vtkTesting.SetFrontBuffer ( int  _arg) [virtual]

Use front buffer for tests. By default use back buffer.

Set and get the render window that will be used for regression testing.

virtual void Kitware.VTK.vtkTesting.SetTempDirectory ( string  _arg) [virtual]

Get some parameters from the command line arguments, env, or defaults.

virtual void Kitware.VTK.vtkTesting.SetValidImageFileName ( string  _arg) [virtual]

Set/Get the name of the valid image file.

virtual void Kitware.VTK.vtkTesting.SetVerbose ( int  _arg) [virtual]

Get/Set verbosity level. A level of 0 is quiet.

static int Kitware.VTK.vtkTesting.Test ( string[]  argv,
vtkRenderWindow  rw,
double  thresh 
) [static]

Undocumented Block.

static internal void Kitware.VTK.vtkTesting.vtkTesting_AddArgument_01 ( HandleRef  pThis,
string  argv 
) [private]
static internal void Kitware.VTK.vtkTesting.vtkTesting_AddArguments_02 ( HandleRef  pThis,
int  argc,
[In, Out] string[]  argv 
) [private]
static internal void Kitware.VTK.vtkTesting.vtkTesting_CleanArguments_03 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTesting.vtkTesting_CompareAverageOfL2Norm_04 ( HandleRef  pThis,
HandleRef  pdA,
HandleRef  pdB,
double  tol 
) [private]
static internal int Kitware.VTK.vtkTesting.vtkTesting_CompareAverageOfL2Norm_05 ( HandleRef  pThis,
HandleRef  daA,
HandleRef  daB,
double  tol 
) [private]
static internal void Kitware.VTK.vtkTesting.vtkTesting_FrontBufferOff_06 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkTesting.vtkTesting_FrontBufferOn_07 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkTesting.vtkTesting_GetArgument_08 ( HandleRef  pThis,
string  arg 
) [private]
static internal int Kitware.VTK.vtkTesting.vtkTesting_GetBorderOffset_09 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkTesting.vtkTesting_GetDataRoot_10 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTesting.vtkTesting_GetFrontBuffer_11 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTesting.vtkTesting_GetFrontBufferMaxValue_12 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTesting.vtkTesting_GetFrontBufferMinValue_13 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkTesting.vtkTesting_GetImageDifference_14 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkTesting.vtkTesting_GetRenderWindow_15 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTesting.vtkTesting_GetTempDirectory_16 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkTesting.vtkTesting_GetValidImageFileName_17 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTesting.vtkTesting_GetVerbose_18 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTesting.vtkTesting_InteractorEventLoop_19 ( int  argc,
[In, Out] string[]  argv,
HandleRef  iren,
string  stream 
) [private]
static internal int Kitware.VTK.vtkTesting.vtkTesting_IsA_20 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkTesting.vtkTesting_IsFlagSpecified_21 ( HandleRef  pThis,
string  flag 
) [private]
static internal int Kitware.VTK.vtkTesting.vtkTesting_IsInteractiveModeSpecified_22 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTesting.vtkTesting_IsTypeOf_23 ( string  type) [private]
static internal int Kitware.VTK.vtkTesting.vtkTesting_IsValidImageSpecified_24 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkTesting.vtkTesting_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTesting.vtkTesting_NewInstance_26 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkTesting.vtkTesting_RegressionTest_27 ( HandleRef  pThis,
double  thresh 
) [private]
static internal int Kitware.VTK.vtkTesting.vtkTesting_RegressionTest_28 ( HandleRef  pThis,
HandleRef  image,
double  thresh 
) [private]
static internal IntPtr Kitware.VTK.vtkTesting.vtkTesting_SafeDownCast_29 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkTesting.vtkTesting_SetBorderOffset_30 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkTesting.vtkTesting_SetDataRoot_31 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkTesting.vtkTesting_SetFrontBuffer_32 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkTesting.vtkTesting_SetRenderWindow_33 ( HandleRef  pThis,
HandleRef  rw 
) [private]
static internal void Kitware.VTK.vtkTesting.vtkTesting_SetTempDirectory_34 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkTesting.vtkTesting_SetValidImageFileName_35 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkTesting.vtkTesting_SetVerbose_36 ( HandleRef  pThis,
int  _arg 
) [private]
static internal int Kitware.VTK.vtkTesting.vtkTesting_Test_37 ( int  argc,
[In, Out] string[]  argv,
HandleRef  rw,
double  thresh 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkTesting.MRClassNameKey = "10vtkTesting" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

new const string Kitware.VTK.vtkTesting.MRFullTypeName = "Kitware.VTK.vtkTesting"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.


The documentation for this class was generated from the following file: