-
Notifications
You must be signed in to change notification settings - Fork 73
Module Conversion Steps
Dan White edited this page Sep 24, 2013
·
28 revisions
- Copy module C++ source file into correct path. Look under src/Modules/Legacy to see if it is already there.
- Example: src/Modules/Legacy/Fields/AlignMeshBoundingBoxes.cc is already checked in, so nothing to do.
- Make a copy of the file SCIRunGUIPrototype/src/Modules/Legacy/Fields/CalculateGradients.h (TODO: general header template) and rename it using the same name as the module. It will act as a template for the newly-required module header file.
- Example: Copied CalculateGradients.h to AlignMeshBoundingBoxes.h.
- Edit the corresponding CMakeLists.txt file to both (a) enable/add the module .cc file, and (b) add the newly-created module header file.
- Example: src/Modules/Legacy/Fields/CMakeLists.txt was edited to add AlignMeshBoundingBoxes.h to the Dataflow_Modules_Legacy_Fields_HEADERS list; and, the line containing AlignMeshBoundingBoxes.cc was uncommented to add both files to the project.
- Under src/Modules/X/Tests, where X is the general category of your module, add a unit test source file both to the filesystem and to the corresponding CMakeLists.txt file.
- Example: Unit tests for the Legacy modules are separated from the Legacy directories to aid file diffing. Thus, a file AlignMeshBoundingBoxesModuleTests.cc was added to src/Modules/Fields/Tests, and then added to the project using CMake. GetFieldBoundaryModuleTests.cc was copied to create the new file; it will be edited in a later step.