Slicer3:Loadable Modules:Phase1 - Revision history

Grundlett: Text replacement - "http://www.slicer.org/slicerWiki/index.php/" to "https://www.slicer.org/wiki/"

2017-07-10T17:50:17Z

Text replacement - "http://www.slicer.org/slicerWiki/index.php/" to "https://www.slicer.org/wiki/"

Marianna: Protected "Slicer3:Loadable Modules:Phase1" [edit=sysop:move=sysop]

2008-05-22T16:10:44Z

Protected "Slicer3:Loadable Modules:Phase1" [edit=sysop:move=sysop]

Marianna: Unprotected "Slicer3:Loadable Modules:Phase1"

2008-05-19T21:48:46Z

Unprotected "Slicer3:Loadable Modules:Phase1"

Marianna: Replacing page with ''''Note:''' We are migrating this content to the slicer.org domain - The newer page is [http://www.slicer.org/slicerWiki/index.php/Slicer3:Loadable_Mo...'

2008-05-19T21:48:35Z

Replacing page with '<big>'''Note:''' We are migrating this content to the slicer.org domain - <font color="orange">The newer page is [http://www.slicer.org/slicerWiki/index.php/Slicer3:Loadable_Mo...'

TerryLorber: /* example XML loadable module description */

2008-04-11T13:43:05Z

example XML loadable module description

TerryLorber at 22:11, 25 March 2008

2008-03-25T22:11:38Z

TerryLorber: /* result of tele-conference 28jan2008 */

2008-03-04T02:29:46Z

result of tele-conference 28jan2008

TerryLorber at 02:28, 4 March 2008

2008-03-04T02:28:49Z

TerryLorber: /* loadable modules entry points */

2008-02-13T02:48:16Z

loadable modules entry points

TerryLorber: /* loadable modules entry points */

2008-02-13T02:31:03Z

loadable modules entry points

← Older revision		Revision as of 17:50, 10 July 2017
Line 1:		Line 1:
−	<big>'''Note:''' We are migrating this content to the slicer.org domain - <font color="orange">The newer page is [~~http~~://www.slicer.org/~~slicerWiki/index.php~~/Slicer3:Loadable_Modules:Phase1 here]</font></big>	+	<big>'''Note:''' We are migrating this content to the slicer.org domain - <font color="orange">The newer page is [https://www.slicer.org/wiki/Slicer3:Loadable_Modules:Phase1 here]</font></big>

← Older revision		Revision as of 21:48, 19 May 2008
Line 1:		Line 1:
−	~~From [[Slicer3~~:~~Loadable_Modules]]:~~	+	<big>'''Note:''' We are migrating this content to the slicer.org domain - <font color="orange">The newer page is [http://www.slicer.org/slicerWiki/index.php/Slicer3:Loadable_Modules:Phase1 here]</font></big>
−	* runtime module discovery
−	* module template
−	* like CommandLineModuleFactory
−
−	~~----~~
−
−
−	~~Starting at ~900 in Applications/GUI/Slicer3.cxx, static modules load occurs.~~
−
−	~~Using vtkSys tools to list shared libraries present. Use itk::DyanmicLoader to open libraries and call our specified entry points.~~
−
−	~~The actions taken for each module to be added could be queried from the found shared library using a LoadableModuleInfo class. Some of the information a library should provide:~~
−
−	* vtkSlicerLogic pointer (maybe this is one of the defined entry points for a loadable module)
−	* methods to call on the Logic pointer
−	* vtkSlicerModulesGUI pointer (ditto)
−	* methods to call on the GUI pointer
−	* module name
−
−	~~LoadableModuleFactory (dervie from? Libs/ModuleDescriptionParser/ModuleFactory.cxx) handles this. Looks like ModuleFactory::ScanForSharedObjectModules does something very similar.~~
−
−
−	~~Create shared libraries for each of the static modules listed in Slicer3.cxx~~
−
−	~~==== loadable modules entry points ====~~
−
−	~~void* GetLoadableModuleGUI~~
−	~~void* GetLoadableModuleLogic~~
−	~~char* GetLoadableModuleDescription~~
−
−	~~That might be it, it~~'~~d be nice to have the module describe the necessary methods to call on the GUI and Logic pointer, but that might be Phase I-A. Within Slicer3_main, there doesn~~'~~t seem to be much variation.~~
−
−	~~Slicer3.cxx also defines [modulename]_Init(Tcl_Interp* interp) functions and calls them for each module. Should~~ this ~~also be conditional for loadable modules? Does it require an additional entry point?~~
−
−	~~==== loadable module support ====~~
−
−
−	~~Is there a header/source file that should be added to every module? Can we follow the CLP methodology and use an XML source and CMake driven tool~~ to ~~generate~~ the ~~necessary files?~~
−
−	~~==== example loadable module description, named SlicerTractographyDisplayModule~~.~~txt ====~~
−
−	~~Name: Slicer Tractography Display~~
−	~~GUIName: LoadDisplaySave~~
−
−	~~===== result of tele~~-~~conference 28jan2008~~ =~~====~~
−
−	~~Things that the module's XML description should be able to tell:~~
−	~~Name~~
−	~~Group~~
−	~~Description~~
−	~~Home Page~~
−	~~Dependencies (on other Groups or Modules and what versions)~~
−	~~Version #~~
−	[~~and maybe:]~~
−	~~icon~~
−	~~Author(s)~~
−	~~Acknowledgment(s)~~
−
−	~~Module Groups for Slicer3:~~
−	~~Base~~
−	~~Segmentation~~
−	~~Registration~~
−	~~Filtering~~
−	~~Diffusion Imaging/Tractography~~
−	~~Modeling~~
−	~~Meshing~~
−	~~Image Guided Therapy~~
−	~~Rendering~~
−	~~Radiation Treatment~~
−	~~Microscopy~~
−	~~Astronomy~~
−	~~Utilities~~
−	~~Databases (XCEDE?)~~
−	~~Other~~
−
−	~~Options users might want to specify when building:~~
−	~~src install vs. binary download~~
−	~~version #'s of libs (e.g. cvs tags or branches to use)~~
−	~~release build vs debug build~~
−	~~clean rebuild~~
−	~~update/refresh libraries~~
−	~~run tests and submit to dashboard~~
−	~~make an installation package~~
−	~~upload to web site~~
−
−	~~==== SVN branch ====~~
−
−	http://www.~~na-mic~~.org/~~svn~~/~~Slicer3~~/~~branches/tgl_loadable_modules/~~
−
−	~~==== References ====~~
−
−	[[Slicer3:~~Execution_Model_Documentation]]~~
−
−	~~[[Slicer3~~:~~How_to_implement_an_Interactive_Module_GUI]~~]

@@ Line 39: / Line 39: @@
 Is there a header/source file that should be added to every module?  Can we follow the CLP methodology and use an XML source and CMake driven tool to generate the necessary files?
-==== example XML loadable module description ====
+==== example loadable module description, named SlicerTractographyDisplayModule.txt ====
-  <?xml version="1.0" encoding="utf-8"?>
+  Name: Slicer Tractography Display
-  <loadable>
+  GUIName: LoadDisplaySave
 ===== result of tele-conference 28jan2008 =====

← Older revision		Revision as of 22:11, 25 March 2008
Line 38:		Line 38:

	Is there a header/source file that should be added to every module? Can we follow the CLP methodology and use an XML source and CMake driven tool to generate the necessary files?		Is there a header/source file that should be added to every module? Can we follow the CLP methodology and use an XML source and CMake driven tool to generate the necessary files?
		+
		+	==== example XML loadable module description ====
		+
		+	<?xml version="1.0" encoding="utf-8"?>
		+	<loadable>
		+	<name>Volume Rendering Module</name>
		+	<shortname>VRModule</shortname>
		+	<guiname>VolumeRendering</guiname>
		+	<tclinitname>Volumerenderingmodule_Init</tclinitname>
		+	<message>Initializing Volume Rendering Module...</message>
		+	</loadable>

	===== result of tele-conference 28jan2008 =====		===== result of tele-conference 28jan2008 =====

@@ Line 42: / Line 42: @@
 Things that the module's XML description should be able to tell:
-- Name
+ Name
-- Group
+ Group
-- Description
+ Description
-- Home Page
+ Home Page
-- Dependencies (on other Groups or Modules and what versions)
+ Dependencies (on other Groups or Modules and what versions)
-- Version #
+ Version #
 [and maybe:]
-- icon
+ icon
-- Author(s)
+ Author(s)
-- Acknowledgment(s)
+ Acknowledgment(s)
 Module Groups for Slicer3:
-- Base
+ Base
-- Segmentation
+ Segmentation
-- Registration
+ Registration
-- Filtering
+ Filtering
-- Diffusion Imaging/Tractography
+ Diffusion Imaging/Tractography
-- Modeling
+ Modeling
-- Meshing
+ Meshing
-- Image Guided Therapy
+ Image Guided Therapy
-- Rendering
+ Rendering
-- Radiation Treatment
+ Radiation Treatment
-- Microscopy
+ Microscopy
-- Astronomy
+ Astronomy
-- Utilities
+ Utilities
-- Databases (XCEDE?)
+ Databases (XCEDE?)
-- Other
+ Other
 Options users might want to specify when building:
-- src install vs. binary download
+ src install vs. binary download
-- version #'s of libs (e.g. cvs tags or branches to use)
+ version #'s of libs (e.g. cvs tags or branches to use)
-- release build vs debug build
+ release build vs debug build
-- clean rebuild
+ clean rebuild
-- update/refresh libraries
+ update/refresh libraries
-- run tests and submit to dashboard
+ run tests and submit to dashboard
-- make an installation package
+ make an installation package
-- upload to web site
+ upload to web site
 ==== SVN branch ====

← Older revision	Revision as of 16:10, 22 May 2008
(No difference)

← Older revision		Revision as of 02:28, 4 March 2008
Line 38:		Line 38:

	Is there a header/source file that should be added to every module? Can we follow the CLP methodology and use an XML source and CMake driven tool to generate the necessary files?		Is there a header/source file that should be added to every module? Can we follow the CLP methodology and use an XML source and CMake driven tool to generate the necessary files?
		+
		+	===== result of tele-conference 28jan2008 =====
		+
		+	Things that the module's XML description should be able to tell:
		+	- Name
		+	- Group
		+	- Description
		+	- Home Page
		+	- Dependencies (on other Groups or Modules and what versions)
		+	- Version #
		+	[and maybe:]
		+	- icon
		+	- Author(s)
		+	- Acknowledgment(s)
		+
		+	Module Groups for Slicer3:
		+	- Base
		+	- Segmentation
		+	- Registration
		+	- Filtering
		+	- Diffusion Imaging/Tractography
		+	- Modeling
		+	- Meshing
		+	- Image Guided Therapy
		+	- Rendering
		+	- Radiation Treatment
		+	- Microscopy
		+	- Astronomy
		+	- Utilities
		+	- Databases (XCEDE?)
		+	- Other
		+
		+	Options users might want to specify when building:
		+	- src install vs. binary download
		+	- version #'s of libs (e.g. cvs tags or branches to use)
		+	- release build vs debug build
		+	- clean rebuild
		+	- update/refresh libraries
		+	- run tests and submit to dashboard
		+	- make an installation package
		+	- upload to web site

	==== SVN branch ====		==== SVN branch ====

@@ Line 32: / Line 32: @@
 That might be it, it'd be nice to have the module describe the necessary methods to call on the GUI and Logic pointer, but that might be Phase I-A.  Within Slicer3_main, there doesn't seem to be much variation.
-Slicer3.cxx also defines *_Init(Tcl_Interp* interp) functions and calls them for each module.  Should this also be conditional for loadable modules?  Does it require an additional entry point?
+Slicer3.cxx also defines [modulename]_Init(Tcl_Interp* interp) functions and calls them for each module.  Should this also be conditional for loadable modules?  Does it require an additional entry point?
 ==== loadable module support ====

← Older revision		Revision as of 02:31, 13 February 2008
Line 31:		Line 31:

	That might be it, it'd be nice to have the module describe the necessary methods to call on the GUI and Logic pointer, but that might be Phase I-A. Within Slicer3_main, there doesn't seem to be much variation.		That might be it, it'd be nice to have the module describe the necessary methods to call on the GUI and Logic pointer, but that might be Phase I-A. Within Slicer3_main, there doesn't seem to be much variation.
		+
		+	Slicer3.cxx also defines _Init(Tcl_Interp interp) functions and calls them for each module. Should this also be conditional for loadable modules? Does it require an additional entry point?

	==== loadable module support ====		==== loadable module support ====