Documentation/Nightly/Developers/IO - Revision history

Arankin: /* Example */ Updating Links

2018-08-01T13:54:00Z

Example: Updating Links

Arankin: /* How to add support for reading a new file format ? */

2018-08-01T13:46:26Z

How to add support for reading a new file format ?

Arankin: /* Main classes */ Updating class names to match current naming scheme

2018-08-01T13:46:06Z

Main classes: Updating class names to match current naming scheme

Essert: /* How to save files programmatically */

2018-01-15T09:18:15Z

How to save files programmatically

Essert: /* How to load files programmatically */

2018-01-15T09:17:58Z

How to load files programmatically

Max.smolens: Fix typo

2015-08-10T17:47:41Z

Fix typo

Max.smolens: Fix typo

2015-08-10T17:37:54Z

Fix typo

Finetjul: /* How to register a dialog ? */

2014-08-01T11:26:32Z

How to register a dialog ?

Finetjul: /* How to save files programmatically */

2013-08-05T15:42:12Z

How to save files programmatically

UpdateBot: Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

2013-06-14T07:51:32Z

Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

@@ Line 28: / Line 28: @@
 == Example ==
 * Models
-** [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Libs/MRML/Core/vtkMRMLModelNode.h?view=markup Libs/MRML/Core/vtkMRMLModelNode]
+** [https://github.com/Slicer/Slicer/blob/master/Libs/MRML/Core/vtkMRMLModelNode.h Libs/MRML/Core/vtkMRMLModelNode]
-** [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Libs/MRML/Core/vtkMRMLModelStorageNode.h?view=markup Libs/MRML/Core/vtkMRMLModelStorageNode]
+** [https://github.com/Slicer/Slicer/blob/master/Libs/MRML/Core/vtkMRMLModelStorageNode.h Libs/MRML/Core/vtkMRMLModelStorageNode]
-** [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Modules/Loadable/Models/Logic/vtkSlicerModelsLogic.h?view=markup Modules/Loadable/Models/Logic/vtkSlicerModelsLogic]
+** [https://github.com/Slicer/Slicer/blob/master/Modules/Loadable/Models/Logic/vtkSlicerModelsLogic.h Modules/Loadable/Models/Logic/vtkSlicerModelsLogic]
-** [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Modules/Loadable/Models/qSlicerModelsIO.h?view=markup Modules/Loadable/Models/qSlicerModelsIO]
+** [https://github.com/Slicer/Slicer/blob/master/Modules/Loadable/Models/qSlicerModelsReader.h Modules/Loadable/Models/qSlicerModelsReader]
-** [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Modules/Loadable/Models/qSlicerModelsModule.h?view=markup Modules/Loadable/Models/qSlicerModelsModule]
+** [https://github.com/Slicer/Slicer/blob/master/Modules/Loadable/Models/qSlicerModelsModule.h Modules/Loadable/Models/qSlicerModelsModule]
 == How to load files programmatically ==

@@ Line 14: / Line 14: @@
 # Write method <code>vtkMRMLXYZStorageNode::ReadDataInternal(vtkMRMLStorableNode*, bool temporary);</code>
 # Write method <code>vtkMRMLXYZsLogic::AddXYZ(const char* fileName, const char nodeName =0);</code>
-# Write class <code>qSlicerXYZsIO</code>
+# Write class <code>qSlicerXYZsReaderPlugin</code>
-# Optional: Write class <code>qSlicerXYZsIOOptionsWidget</code> if you want the user to optionally specify loading options.
+# Optional: Write class <code>qSlicerXYZsOptionsWidget</code> if you want the user to optionally specify loading options.
 # In <code>qSlicerXYZsModule::setup()</code>, instantiate and register <code>qSlicerXYZsIO</code> to <code>qSlicerCoreIOManager</code>
 # Add file format to [Documentation/{{documentation/version}}/SlicerApplication/SupportedDataFormat|SupportedDataFormat] wiki page

@@ Line 6: / Line 6: @@
 * <code>vtkSlicer<i>XYZ</i>StorageNode</code> is the file reader. It populates the storable node using the method  <code>vtkMRML<i>XYZ</i>StorageNode::ReadData(vtkMRMLStorableNode*,bool)</code>.
 * <code>vtkSlicer<i>XYZ</i>sLogic</code> is the MRML logic of the <code>XYZ</code> module. It exposes a convenient method <code>AddXYZ(const char* fileName, const char* nodeName=0);</code> that creates a MRML <i>XYZ</i> node (<code>vtkMRML<i>XYZ</i>Node</code>)and its associated storage node (<code>vtkMRML<i>XYZ</i>StorageNode</code>), add them into the scene, and call <code>vtkMRML<i>XYZ</i>StorageNode::ReadData(vtkMRMLStorableNode*,bool);</code> on the storage node to load the file. If the loading fails, it removes the previously created nodes from the scene.
-* <code>qSlicer<i>XYZ</i>sIO</code> is a plugin that is registered by modules into the <code>qSlicerCoreIOManager</code>. It is the interface between Qt and MRML logics. It internally calls <code>vtkSlicer<i>XYZ</i>sLogic::Add<i>XYZ</i></code>().
+* <code>qSlicer<i>XYZ</i>sReaderPlugin</code> is a plugin that is registered by modules into the <code>qSlicerCoreIOManager</code>. It is the interface between Qt and MRML logics. It internally calls <code>vtkSlicer<i>XYZ</i>sLogic::Add<i>XYZ</i></code>().
-* <code>qSlicer<i>XYZ</i>sIOOptionsWidget</code> is a widget that sets loading options that gets passed to the logic.
+* <code>qSlicer<i>XYZ</i>sOptionsWidget</code> is a widget that sets loading options that gets passed to the logic.
 * <code>qSlicerCoreIOManager</code> is the central class where any IO operation must go through. qSlicerIOs can be registered using <code>qSlicerCoreIOManager::registerIO(qSlicerIO*)</code> and nodes can be loaded using <code>qSlicerCoreIOManager::loadNodes(...)</code>. It exposes a set of convenient methods such as "what reader must be used for what file".
 * <code>qSlicerDataDialog</code> is the dialog that allows the user to select the files to load.

@@ Line 64: / Line 64: @@
   fileParameters["nodeID"] = volumeNode->GetID();
   fileParameters["fileName"] = "/path/of/file.ext";
-  coreIOManager->[http://slicer.org/doc/html/classqSlicerCoreIOManager.html#a1cd29140ded984afdd0f667064d38845 saveNodes]("VolumeFile", parameters);
+  coreIOManager->[http://slicer.org/doc/html/classqSlicerCoreIOManager.html#a1cd29140ded984afdd0f667064d38845 saveNodes]("VolumeFile", fileParameters);
 Works also with "ModelFile", "TransformFile", "SceneFile"...
 | valign="top" |

@@ Line 42: / Line 42: @@
   [http://slicer.org/doc/html/classqSlicerCoreIOManager.html qSlicerCoreIOManager]* coreIOManager = qSlicerCoreApplication::application()->coreIOManager();
   qSlicerIO::IOProperties fileParameters;
-  fileParameters["filename"] = "/path/of/file.ext";
+  fileParameters["fileName"] = "/path/of/file.ext";
-  vtkMRMLNode* volumeNode = coreIOManager->[http://slicer.org/doc/html/classqSlicerCoreIOManager.html#a36a78dba553b52f395f997fe11aaff23 loadNodesAndGetFirst]("VolumeFile", parameters);
+  vtkMRMLNode* volumeNode = coreIOManager->[http://slicer.org/doc/html/classqSlicerCoreIOManager.html#a36a78dba553b52f395f997fe11aaff23 loadNodesAndGetFirst]("VolumeFile", fileParameters);
 Works also with "ModelFile", "TransformFile", "SceneFile"...
 | valign="top" |

@@ Line 77: / Line 77: @@
 * <code>[http://slicer.org/doc/html/classqSlicerSaveDataDialog.html qSlicerSaveDataDialog]</code> is the default dialog to save files.
-By default, all the IOs must be done through <code>qSlicerDataDialog</code> for reading files and <code>qSlicerSaveDataDialog</code> for writting files. However, due to historical reasons, it is possible to have custom dialogs for each node types.
+By default, all the IOs must be done through <code>qSlicerDataDialog</code> for reading files and <code>qSlicerSaveDataDialog</code> for writing files. However, due to historical reasons, it is possible to have custom dialogs for each node types.
 It can be useful to create your own IO dialog to add custom behavior to the Slicer drag&drop default behavior.

@@ Line 24: / Line 24: @@
 <code>vtkMRMLStorageNode</code> keeps track of when a file was last read or written (<code>vtkTimeStamp* vtkMRMLStorageNode::StoredTime</code>). <code>vtkMRMLStorableNode</code> keeps track of when the data was last modified (<code>vtkTimeStamp vtkMRMLStorableNode::StorableModifiedTime</code>). Anytime a <code>vtkMRMLStorableNode</code> property that is saved in file is modified, the <code>StorableModifiedTime</code> time stamp must be modified.
-At exit time (<code>qSlicerMainWindow::closeEvent()</code>), <code>vtkMRMLStorableNode::GetModifiedSinceRead()</code> is called to check if the data in the node is the same as in the file or if it has been modified after the file was last read or written. It internally checks <code>vtkTimeStamp* vtkMRMLStorageNode::StoredTime</code> and <code>vtkTimeStamp vtkMRMLStorableNode::StorableModifiedTime</code>. If the data is more recent, then a message dialog is shown to the user telling him that some data is different from file; leaving without saving will loose the changes.
+At exit time (<code>qSlicerMainWindow::closeEvent()</code>), <code>vtkMRMLStorableNode::GetModifiedSinceRead()</code> is called to check if the data in the node is the same as in the file or if it has been modified after the file was last read or written. It internally checks <code>vtkTimeStamp* vtkMRMLStorageNode::StoredTime</code> and <code>vtkTimeStamp vtkMRMLStorableNode::StorableModifiedTime</code>. If the data is more recent, then a message dialog is shown to the user telling him that some data is different from file; leaving without saving will lose the changes.
 == Example ==

@@ Line 91: / Line 91: @@
   ioManager->[http://slicer.org/doc/html/classqSlicerIOManager.html#ae47e9cf27f230335b865bce84a56e156 registerDialog](new qSlicerSaveXYZDialog(this));
 | valign="top" |
-Declare an XYZFileDialog in your XYZ.py module file. For example:
+Declare an XYZFileDialog in your XYZ.py module file. It will be automatically registered. For example:
   class XYZFileDialog:
     def __init__(self, parent):
@@ Line 105: / Line 105: @@
     def execDialog(self):
       print 'exec'
 |}

← Older revision		Revision as of 07:51, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	=Read=		=Read=
	[[Image:IOOverview.png\|600px\|center]]		[[Image:IOOverview.png\|600px\|center]]