Slicer 5.11
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
Loading...
Searching...
No Matches
Macros
vtkMRMLCoreTestingMacros.h File Reference
#include <vtkMath.h>
#include <iostream>
#include "vtkMRMLCoreTestingUtilities.h"
#include "vtkMRMLNode.h"
#include <vtkAddonTestingMacros.h>
Include dependency graph for vtkMRMLCoreTestingMacros.h:

Go to the source code of this file.

Macros

#define CHECK_NODE_ID_AND_NAME(node, expectedID, expectedName)
 Verifies if the node's ID and name are the same as expected.
 
#define CHECK_NODE_IN_SCENE_BY_ID(scene, nodeID, expected)
 Verifies if the node's pointer defined by nodeID in scene is the same as expected.
 
#define EXERCISE_ALL_BASIC_MRML_METHODS(node)
 Tests all applicable common MRML node methods.
 
#define EXERCISE_BASIC_DISPLAY_MRML_METHODS(className, node)
 
#define EXERCISE_BASIC_DISPLAYABLE_MRML_METHODS(className, node)
 
#define EXERCISE_BASIC_MRML_METHODS(className, node)
 
#define EXERCISE_BASIC_OBJECT_METHODS(node)
 
#define EXERCISE_BASIC_STORABLE_MRML_METHODS(className, node)
 
#define EXERCISE_BASIC_STORAGE_MRML_METHODS(className, node)
 
#define EXERCISE_BASIC_TRANSFORM_MRML_METHODS(className, node)
 
#define EXERCISE_BASIC_TRANSFORMABLE_MRML_METHODS(className, node)
 
#define TEST_GET_OBJECT(object, variable)
 test an object variable via Get
 
#define TEST_ITK_SET_GET(variable, command)
 test itk set/get
 
#define TEST_ITK_SET_GET_VALUE(variable, command)
 test itk set/get
 
#define TEST_SET_GET_BOOLEAN(object, variable)
 test object by calling Set on the variable with false, true, 0, 1, On, Off
 
#define TEST_SET_GET_DOUBLE(object, variable, value)
 
#define TEST_SET_GET_DOUBLE_RANDOM(object, variable, max)
 
#define TEST_SET_GET_DOUBLE_RANGE(object, variable, min, max)
 
#define TEST_SET_GET_INT(object, variable, value)
 
#define TEST_SET_GET_INT_RANDOM(object, variable, max)
 
#define TEST_SET_GET_INT_RANGE(object, variable, min, max)
 
#define TEST_SET_GET_STD_STRING(object, variable)
 test a string variable on the object by calling Set/Get
 
#define TEST_SET_GET_STRING(object, variable)
 test a string variable on the object by calling Set/Get
 
#define TEST_SET_GET_UNSIGNED_INT_RANGE(object, variable, min, max)
 
#define TEST_SET_GET_VALUE(object, variable, value)
 
#define TEST_SET_GET_VECTOR3_DOUBLE(object, variable, x, y, z)
 
#define TEST_SET_GET_VECTOR3_DOUBLE_RANDOM(object, variable, max)
 
#define TEST_SET_GET_VECTOR3_DOUBLE_RANGE(object, variable, min, max)
 
#define TRY_EXPECT_ITK_EXCEPTION(command)
 try the itk command passed in, succeeding if catch an exception
 
#define TRY_EXPECT_NO_ITK_EXCEPTION(command)
 try the command passed in, succeeding if no exception
 

Macro Definition Documentation

◆ CHECK_NODE_ID_AND_NAME

#define CHECK_NODE_ID_AND_NAME ( node,
expectedID,
expectedName )
Value:
{ \
if (!vtkMRMLCoreTestingUtilities::CheckNodeIdAndName(__LINE__, (node), (expectedID), (expectedName))) \
{ \
return EXIT_FAILURE; \
} \
}
vtkMRMLCoreTestingUtilities::CheckNodeIdAndName
VTK_MRML_EXPORT bool CheckNodeIdAndName(int line, vtkMRMLNode *node, const char *expectedID, const char *expectedName)

Verifies if the node's ID and name are the same as expected.

Definition at line 38 of file vtkMRMLCoreTestingMacros.h.

◆ CHECK_NODE_IN_SCENE_BY_ID

#define CHECK_NODE_IN_SCENE_BY_ID ( scene,
nodeID,
expected )
Value:
{ \
if (!vtkMRMLCoreTestingUtilities::CheckNodeInSceneByID(__LINE__, (scene), (nodeID), (expected))) \
{ \
return EXIT_FAILURE; \
} \
}
vtkMRMLCoreTestingUtilities::CheckNodeInSceneByID
VTK_MRML_EXPORT bool CheckNodeInSceneByID(int line, vtkMRMLScene *scene, const char *nodeID, vtkMRMLNode *expected)

Verifies if the node's pointer defined by nodeID in scene is the same as expected.

Convenience macros for unit tests.

The macro returns from the current method with EXIT_FAILURE if the check fails. Expressions can be passed as arguments, they are guaranteed to be executed only once.

Definition at line 29 of file vtkMRMLCoreTestingMacros.h.

◆ EXERCISE_ALL_BASIC_MRML_METHODS

#define EXERCISE_ALL_BASIC_MRML_METHODS ( node)
Value:
CHECK_EXIT_SUCCESS(vtkMRMLCoreTestingUtilities::ExerciseAllBasicMRMLMethods(node));
vtkMRMLCoreTestingUtilities::ExerciseAllBasicMRMLMethods
VTK_MRML_EXPORT int ExerciseAllBasicMRMLMethods(vtkMRMLNode *object)

Tests all applicable common MRML node methods.

Definition at line 407 of file vtkMRMLCoreTestingMacros.h.

◆ EXERCISE_BASIC_DISPLAY_MRML_METHODS

#define EXERCISE_BASIC_DISPLAY_MRML_METHODS ( className,
node )
Value:
CHECK_EXIT_SUCCESS(vtkMRMLCoreTestingUtilities::ExerciseBasicDisplayMRMLMethods(node));
vtkMRMLCoreTestingUtilities::ExerciseBasicDisplayMRMLMethods
VTK_MRML_EXPORT int ExerciseBasicDisplayMRMLMethods(vtkMRMLDisplayNode *node)

Definition at line 422 of file vtkMRMLCoreTestingMacros.h.

◆ EXERCISE_BASIC_DISPLAYABLE_MRML_METHODS

#define EXERCISE_BASIC_DISPLAYABLE_MRML_METHODS ( className,
node )
Value:
CHECK_EXIT_SUCCESS(vtkMRMLCoreTestingUtilities::ExerciseBasicDisplayableMRMLMethods(node));
vtkMRMLCoreTestingUtilities::ExerciseBasicDisplayableMRMLMethods
VTK_MRML_EXPORT int ExerciseBasicDisplayableMRMLMethods(vtkMRMLDisplayableNode *node)

Definition at line 420 of file vtkMRMLCoreTestingMacros.h.

◆ EXERCISE_BASIC_MRML_METHODS

#define EXERCISE_BASIC_MRML_METHODS ( className,
node )
Value:
CHECK_EXIT_SUCCESS(vtkMRMLCoreTestingUtilities::ExerciseBasicMRMLMethods(node));
vtkMRMLCoreTestingUtilities::ExerciseBasicMRMLMethods
VTK_MRML_EXPORT int ExerciseBasicMRMLMethods(vtkMRMLNode *node)
Slicer Libs/MRML/vtkMRMLNode exercises.

Definition at line 414 of file vtkMRMLCoreTestingMacros.h.

◆ EXERCISE_BASIC_OBJECT_METHODS

#define EXERCISE_BASIC_OBJECT_METHODS ( node)
Value:
{ \
int result = vtkMRMLCoreTestingUtilities::ExerciseBasicObjectMethods(node); \
if (result != EXIT_SUCCESS) \
{ \
return result; \
} \
}
vtkMRMLCoreTestingUtilities::ExerciseBasicObjectMethods
VTK_MRML_EXPORT int ExerciseBasicObjectMethods(vtkObject *object)
Test basic VTK object methods (print, superclass, etc.)

Definition at line 397 of file vtkMRMLCoreTestingMacros.h.

◆ EXERCISE_BASIC_STORABLE_MRML_METHODS

#define EXERCISE_BASIC_STORABLE_MRML_METHODS ( className,
node )
Value:
CHECK_EXIT_SUCCESS(vtkMRMLCoreTestingUtilities::ExerciseBasicStorableMRMLMethods(node));
vtkMRMLCoreTestingUtilities::ExerciseBasicStorableMRMLMethods
VTK_MRML_EXPORT int ExerciseBasicStorableMRMLMethods(vtkMRMLStorableNode *node)

Definition at line 416 of file vtkMRMLCoreTestingMacros.h.

◆ EXERCISE_BASIC_STORAGE_MRML_METHODS

#define EXERCISE_BASIC_STORAGE_MRML_METHODS ( className,
node )
Value:
CHECK_EXIT_SUCCESS(vtkMRMLCoreTestingUtilities::ExerciseBasicStorageMRMLMethods(node));
vtkMRMLCoreTestingUtilities::ExerciseBasicStorageMRMLMethods
VTK_MRML_EXPORT int ExerciseBasicStorageMRMLMethods(vtkMRMLStorageNode *node)

Definition at line 424 of file vtkMRMLCoreTestingMacros.h.

◆ EXERCISE_BASIC_TRANSFORM_MRML_METHODS

#define EXERCISE_BASIC_TRANSFORM_MRML_METHODS ( className,
node )
Value:
CHECK_EXIT_SUCCESS(vtkMRMLCoreTestingUtilities::ExerciseBasicTransformMRMLMethods(node));
vtkMRMLCoreTestingUtilities::ExerciseBasicTransformMRMLMethods
VTK_MRML_EXPORT int ExerciseBasicTransformMRMLMethods(vtkMRMLTransformNode *node)

Definition at line 426 of file vtkMRMLCoreTestingMacros.h.

◆ EXERCISE_BASIC_TRANSFORMABLE_MRML_METHODS

#define EXERCISE_BASIC_TRANSFORMABLE_MRML_METHODS ( className,
node )
Value:
CHECK_EXIT_SUCCESS(vtkMRMLCoreTestingUtilities::ExerciseBasicTransformableMRMLMethods(node));
vtkMRMLCoreTestingUtilities::ExerciseBasicTransformableMRMLMethods
VTK_MRML_EXPORT int ExerciseBasicTransformableMRMLMethods(vtkMRMLTransformableNode *node)

Definition at line 418 of file vtkMRMLCoreTestingMacros.h.

◆ TEST_GET_OBJECT

#define TEST_GET_OBJECT ( object,
variable )
Value:
if (!object->Get##variable()) \
{ \
std::cerr << "Error in Get" #variable << ", non null value is expected " << std::endl; \
return EXIT_FAILURE; \
} \
object->Get##variable()->Print(std::cout);

test an object variable via Get

Definition at line 255 of file vtkMRMLCoreTestingMacros.h.

◆ TEST_ITK_SET_GET

#define TEST_ITK_SET_GET ( variable,
command )
Value:
if (variable.GetPointer() != command) \
{ \
std::cerr << "Error in " << #command << std::endl; \
std::cerr << "Expected " << variable.GetPointer() << std::endl; \
std::cerr << "but got " << command << std::endl; \
return EXIT_FAILURE; \
}

test itk set/get

Definition at line 78 of file vtkMRMLCoreTestingMacros.h.

◆ TEST_ITK_SET_GET_VALUE

#define TEST_ITK_SET_GET_VALUE ( variable,
command )
Value:
if (variable != command) \
{ \
std::cerr << "Error in " << #command << std::endl; \
std::cerr << "Expected " << variable << std::endl; \
std::cerr << "but got " << command << std::endl; \
return EXIT_FAILURE; \
}

test itk set/get

Definition at line 89 of file vtkMRMLCoreTestingMacros.h.

◆ TEST_SET_GET_BOOLEAN

#define TEST_SET_GET_BOOLEAN ( object,
variable )
Value:
object->Set##variable(false); \
object->Set##variable(true); \
if (object->Get##variable() == 0) \
{ \
std::cerr << "Error in Set/Get" #variable << ", Get" #variable << " returned zero while it is expected to return non-zero" << std::endl; \
return EXIT_FAILURE; \
} \
object->Set##variable(false); \
if (object->Get##variable() != 0) \
{ \
std::cerr << "Error in Set/Get" #variable << ", Get" #variable << " returned " << object->Get##variable() << " instead of 0" << std::endl; \
return EXIT_FAILURE; \
} \
object->variable##On(); \
if (object->Get##variable() == 0) \
{ \
std::cerr << "Error in On/Get" #variable << ", Get" #variable << " returned zero while it is expected to return non-zero" << std::endl; \
return EXIT_FAILURE; \
} \
object->variable##Off(); \
if (object->Get##variable() != 0) \
{ \
std::cerr << "Error in Off/Get" #variable << ", Get" #variable << " returned " << object->Get##variable() << " while 0 is expected" << std::endl; \
return EXIT_FAILURE; \
}

test object by calling Set on the variable with false, true, 0, 1, On, Off

Definition at line 100 of file vtkMRMLCoreTestingMacros.h.

◆ TEST_SET_GET_DOUBLE

#define TEST_SET_GET_DOUBLE ( object,
variable,
value )
Value:
{ \
object->Set##variable(value); \
if (object->Get##variable() != value) \
{ \
std::cerr << "Error in Set/Get" #variable << " using value " << value << std::endl; \
return EXIT_FAILURE; \
} \
}

test a double variable on the object by setting it to input value using Set, and testing it via the Get

Definition at line 205 of file vtkMRMLCoreTestingMacros.h.

◆ TEST_SET_GET_DOUBLE_RANDOM

#define TEST_SET_GET_DOUBLE_RANDOM ( object,
variable,
max )
Value:
{ \
double val = vtkMath::Random() * max; \
object->Set##variable(val); \
if (object->Get##variable() != val) \
{ \
std::cerr << "Error in Set/Get" #variable << ", using random value " << val << std::endl; \
return EXIT_FAILURE; \
} \
}

test an integer variable on the object by setting it to a random value up to max using Set, and testing it via the Get

Definition at line 242 of file vtkMRMLCoreTestingMacros.h.

◆ TEST_SET_GET_DOUBLE_RANGE

#define TEST_SET_GET_DOUBLE_RANGE ( object,
variable,
min,
max )
Value:
{ \
double epsilon = 1.0; \
double val = min - epsilon; \
TEST_SET_GET_DOUBLE(object, variable, val); \
val = min; \
TEST_SET_GET_DOUBLE(object, variable, val); \
val = min + epsilon; \
TEST_SET_GET_DOUBLE(object, variable, val); \
val = (min + max) / 2.0; \
TEST_SET_GET_DOUBLE(object, variable, val); \
val = max - epsilon; \
TEST_SET_GET_DOUBLE(object, variable, val); \
val = max; \
TEST_SET_GET_DOUBLE(object, variable, val); \
val = max + epsilon; \
TEST_SET_GET_DOUBLE(object, variable, val); \
}

Test a double variable on object over the range, calls test set get in with min - epsilon, min, min + epsilon, (min+max)/2, max - epsilon, max, max + epsilon, where first and last test should report errors epsilon set to 1.0

Definition at line 220 of file vtkMRMLCoreTestingMacros.h.

◆ TEST_SET_GET_INT

#define TEST_SET_GET_INT ( object,
variable,
value )
Value:
{ \
object->Set##variable(value); \
if (object->Get##variable() != value) \
{ \
std::cerr << "Error in Set/Get" #variable << " using value " << value << std::endl; \
return EXIT_FAILURE; \
} \
}

test an integer variable on the object by setting it to input value using Set, and testing it via the Get

Definition at line 130 of file vtkMRMLCoreTestingMacros.h.

◆ TEST_SET_GET_INT_RANDOM

#define TEST_SET_GET_INT_RANDOM ( object,
variable,
max )
Value:
{ \
int val = (int)(vtkMath::Random() * max); \
object->Set##variable(val); \
if (object->Get##variable() != val) \
{ \
std::cerr << "Error in Set/Get" #variable << " using random value " << val << std::endl; \
return EXIT_FAILURE; \
} \
}

test an integer variable on the object by setting it to a random value up to max using Set, and testing it via the Get

Definition at line 167 of file vtkMRMLCoreTestingMacros.h.

◆ TEST_SET_GET_INT_RANGE

#define TEST_SET_GET_INT_RANGE ( object,
variable,
min,
max )
Value:
{ \
int epsilon = 1; \
int val = min - epsilon; \
TEST_SET_GET_INT(object, variable, val); \
val = min; \
TEST_SET_GET_INT(object, variable, val); \
val = min + epsilon; \
TEST_SET_GET_INT(object, variable, val); \
val = (min + max) / 2; \
TEST_SET_GET_INT(object, variable, val); \
val = max - epsilon; \
TEST_SET_GET_INT(object, variable, val); \
val = max; \
TEST_SET_GET_INT(object, variable, val); \
val = max + epsilon; \
TEST_SET_GET_INT(object, variable, val); \
}

Test an integer variable on object over the range, calls test set get in with min - epsilon, min, min + epsilon, (min+max)/2, max - epsilon, max, max + epsilon, where first and last test should report errors epsilon defined as 1

Definition at line 145 of file vtkMRMLCoreTestingMacros.h.

◆ TEST_SET_GET_STD_STRING

#define TEST_SET_GET_STD_STRING ( object,
variable )
Value:
{ \
std::string originalString = object->Get##variable(); \
object->Set##variable("testing with a const char"); \
if (object->Get##variable() != "testing with a const char") \
{ \
std::cerr << "Error in Set/Get" #variable << " with a string literal" << std::endl; \
return EXIT_FAILURE; \
} \
std::string string1 = "testingIsGood"; \
object->Set##variable(string1); \
if (object->Get##variable() != string1) \
{ \
std::cerr << "Error in Set/Get" #variable << ", tried to set to " << string1 << " but got " << object->Get##variable() << std::endl; \
return EXIT_FAILURE; \
} \
std::string string2 = "moreTestingIsBetter"; \
object->Set##variable(string2); \
if (object->Get##variable() != string2) \
{ \
std::cerr << "Error in Set/Get" #variable << ", tried to set to " << string2 << " but got " << object->Get##variable() << std::endl; \
return EXIT_FAILURE; \
} \
object->Set##variable(originalString); \
}

test a string variable on the object by calling Set/Get

Definition at line 371 of file vtkMRMLCoreTestingMacros.h.

◆ TEST_SET_GET_STRING

#define TEST_SET_GET_STRING ( object,
variable )

test a string variable on the object by calling Set/Get

Definition at line 329 of file vtkMRMLCoreTestingMacros.h.

◆ TEST_SET_GET_UNSIGNED_INT_RANGE

#define TEST_SET_GET_UNSIGNED_INT_RANGE ( object,
variable,
min,
max )
Value:
{ \
unsigned int epsilon = 1; \
unsigned int val = min - epsilon; \
TEST_SET_GET_INT(object, variable, val); \
val = min; \
TEST_SET_GET_INT(object, variable, val); \
val = min + epsilon; \
TEST_SET_GET_INT(object, variable, val); \
val = (min + max) / 2; \
TEST_SET_GET_INT(object, variable, val); \
val = max - epsilon; \
TEST_SET_GET_INT(object, variable, val); \
val = max; \
TEST_SET_GET_INT(object, variable, val); \
val = max + epsilon; \
TEST_SET_GET_INT(object, variable, val); \
}

Test an unsigned integer variable on object over the range, calls test set get in with min - epsilon, min, min + epsilon, (min+max)/2, max - epsilon, max, max + epsilon, where first and last test should report errors epsilon defined as 1

Definition at line 183 of file vtkMRMLCoreTestingMacros.h.

◆ TEST_SET_GET_VALUE

#define TEST_SET_GET_VALUE ( object,
variable,
value )
Value:
object->Set##variable(value); \
if (object->Get##variable() != value) \
{ \
std::cerr << "Error getting " << #variable << std::endl; \
std::cerr << "Expected " << value << std::endl; \
std::cerr << "but got " << object->Get##variable() << std::endl; \
return EXIT_FAILURE; \
}

test an object variable on the object by setting it to input value using Set, and testing it via the Get

Definition at line 266 of file vtkMRMLCoreTestingMacros.h.

◆ TEST_SET_GET_VECTOR3_DOUBLE

#define TEST_SET_GET_VECTOR3_DOUBLE ( object,
variable,
x,
y,
z )
Value:
{ \
object->Set##variable(x, y, z); \
double* val = object->Get##variable(); \
if (val == nullptr || val[0] != x || val[1] != y || val[2] != z) \
{ \
std::cerr << "Error in Set/Get" #variable << std::endl; \
return EXIT_FAILURE; \
} \
}

test a vector variable on the object by setting it to a the values x, y, z passed in using Set, and testing it via the Get

Definition at line 279 of file vtkMRMLCoreTestingMacros.h.

◆ TEST_SET_GET_VECTOR3_DOUBLE_RANDOM

#define TEST_SET_GET_VECTOR3_DOUBLE_RANDOM ( object,
variable,
max )
Value:
{ \
double x = vtkMath::Random() * max; \
double y = vtkMath::Random() * max; \
double z = vtkMath::Random() * max; \
object->Set##variable(x, y, z); \
double val[3] = { 0.0, 0.0, 0.0 }; \
object->Get##variable(val); \
if (val[0] != x || val[1] != y || val[2] != z) \
{ \
std::cerr << "Error in Set/Get" #variable << " with " << x << ", " << y << ", " << z << std::endl; \
return EXIT_FAILURE; \
} \
}

test a vector variable on the object by setting all it's elements to the same random value up to max using Set, and testing it via the Get

Definition at line 312 of file vtkMRMLCoreTestingMacros.h.

◆ TEST_SET_GET_VECTOR3_DOUBLE_RANGE

#define TEST_SET_GET_VECTOR3_DOUBLE_RANGE ( object,
variable,
min,
max )
Value:
{ \
double epsilon = 1.0; \
TEST_SET_GET_VECTOR3_DOUBLE(object, variable, min - epsilon, min - epsilon, min - epsilon); \
TEST_SET_GET_VECTOR3_DOUBLE(object, variable, min, min, min); \
TEST_SET_GET_VECTOR3_DOUBLE(object, variable, min + epsilon, min + epsilon, min + epsilon); \
double half = (min + max / 2.0); \
TEST_SET_GET_VECTOR3_DOUBLE(object, variable, half, half, half); \
TEST_SET_GET_VECTOR3_DOUBLE(object, variable, max - epsilon, max - epsilon, max - epsilon); \
TEST_SET_GET_VECTOR3_DOUBLE(object, variable, max, max, max); \
TEST_SET_GET_VECTOR3_DOUBLE(object, variable, max + epsilon, max + epsilon, max + epsilon); \
}

Test a double vector variable on object over the range, calls test set get in with min - epsilon, min, min + epsilon, (min+max)/2, max - epsilon, max, max + epsilon, where first and last test should report errors. For now all three elements are set to the same thing each time. epsilon set to 1.0

Definition at line 296 of file vtkMRMLCoreTestingMacros.h.

◆ TRY_EXPECT_ITK_EXCEPTION

#define TRY_EXPECT_ITK_EXCEPTION ( command)
Value:
try \
{ \
std::cout << "Trying " << #command << std::endl; \
command; \
std::cerr << "Failed to catch expected exception" << std::endl; \
return EXIT_FAILURE; \
} \
catch (itk::ExceptionObject & excp) \
{ \
std::cout << "Caught expected exception" << std::endl; \
std::cout << excp << std::endl; \
}

try the itk command passed in, succeeding if catch an exception

Definition at line 48 of file vtkMRMLCoreTestingMacros.h.

◆ TRY_EXPECT_NO_ITK_EXCEPTION

#define TRY_EXPECT_NO_ITK_EXCEPTION ( command)
Value:
try \
{ \
std::cout << "Trying " << #command << std::endl; \
command; \
} \
catch (itk::ExceptionObject & excp) \
{ \
std::cerr << excp << std::endl; \
return EXIT_FAILURE; \
}

try the command passed in, succeeding if no exception

Definition at line 64 of file vtkMRMLCoreTestingMacros.h.

Generated on Mon Jan 5 2026 04:11:56 for Slicer by doxygen 1.13.0