ITK/Release 4/Modularization/Add new classes: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
No edit summary
No edit summary
Line 4: Line 4:


*  Which module it belongs to?
*  Which module it belongs to?
  The module grouping is listed in ITK/CMake/ITKGroup.cmake.
The module grouping is listed in ITK/CMake/ITKGroup.cmake.  
   
   
*  Does the new class brings in new dependency to this module?
*  Does the new class brings in new dependency to this module?
  If yes, then you need to edit the module's dependency list in itk-module.cmake.
If yes, then you need to edit the module's dependency list in itk-module.cmake. One should avoid adding module dependencies without
consulting the developer's list.
    
    
*  Put code in the right directory
*  Put code in the right directory
  If it is a template class, put the header and the template files into "include" directory.
If it is a template class, put the header and the template files into "include" directory.
  If it is a library source class, put the cxx file into "src" directory, and the corresponding header into "include" directory. Also need to edit the src/CMakeLists.txt accordingly.
If it is a library source class, put the cxx file into "src" directory, and the corresponding header into "include" directory. Also need to edit the src/CMakeLists.txt accordingly.
 


*  Add unit tests
*  Add unit tests
  Edit the test/CMakeList.txt according to the notes in [http://www.itk.org/Wiki/ITK_Release_4/Modularization/_Add_tests  Add tests]
Edit the test/CMakeList.txt according to the notes in [http://www.itk.org/Wiki/ITK_Release_4/Modularization/_Add_tests  Add tests]

Revision as of 21:03, 4 April 2011

It is necessary to understand the structure of a module before adding a class to it, please read Add a module first.


  • Which module it belongs to?

The module grouping is listed in ITK/CMake/ITKGroup.cmake.


  • Does the new class brings in new dependency to this module?

If yes, then you need to edit the module's dependency list in itk-module.cmake. One should avoid adding module dependencies without consulting the developer's list.


  • Put code in the right directory

If it is a template class, put the header and the template files into "include" directory. If it is a library source class, put the cxx file into "src" directory, and the corresponding header into "include" directory. Also need to edit the src/CMakeLists.txt accordingly.


  • Add unit tests

Edit the test/CMakeList.txt according to the notes in Add tests