ENH: Add Python-accessible CLI progress query method

The method allows Jupyter notebook widgets to report progress during CLI execution.
Slicer · May 7, 2020 · 865dd83 · 865dd83
1 parent 07c5324
commit 865dd83
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/Libs/MRML/CLI/vtkMRMLCommandLineModuleNode.cxx b/Libs/MRML/CLI/vtkMRMLCommandLineModuleNode.cxx
@@ -567,6 +567,12 @@ bool vtkMRMLCommandLineModuleNode::IsBusy() const
   return this->Internal->Status & vtkMRMLCommandLineModuleNode::BusyMask;
 }
 
+//----------------------------------------------------------------------------
+int vtkMRMLCommandLineModuleNode::GetProgress() const
+{
+  return vtkMath::Round(this->GetModuleDescription().GetProcessInformation()->Progress * 100.0);
+}
+
 //----------------------------------------------------------------------------
 void vtkMRMLCommandLineModuleNode::SetAutoRun(bool autoRun)
 {

diff --git a/Libs/MRML/CLI/vtkMRMLCommandLineModuleNode.h b/Libs/MRML/CLI/vtkMRMLCommandLineModuleNode.h
@@ -130,6 +130,8 @@ class VTK_MRML_CLI_EXPORT vtkMRMLCommandLineModuleNode : public vtkMRMLNode
   /// \sa SetStatus(), GetStatus(), BusyMask, Cancel()
   bool IsBusy()const;
 
+  int GetProgress()const;
+
   /// Set a request to stop the processing of the CLI.
   /// Do nothing if the module is not "busy".
   /// \sa IsBusy(), Cancelling, Cancelled