vtkSlicerCLIModuleLogic.h

Go to the documentation of this file.

/*=auto=========================================================================
 
 Portions (c) Copyright 2005 Brigham and Women's Hospital (BWH)
 All Rights Reserved.
 
 See COPYRIGHT.txt
 or http://www.slicer.org/copyright/copyright.txt for details.
 
 Program:   3D Slicer
 
=========================================================================auto=*/
 
#ifndef __vtkSlicerCLIModuleLogic_h
#define __vtkSlicerCLIModuleLogic_h
 
// Slicer includes
#include "vtkSlicerModuleLogic.h"
 
// MRMLCLI includes
#include "vtkMRMLCommandLineModuleNode.h"
class ModuleDescription;
class ModuleParameter;
 
// MRML include
#include "vtkMRMLScene.h"
class vtkMRMLModelHierarchyNode;
class MRMLIDMap;
 
// STL includes
#include <string>
 
#include "vtkSlicerBaseLogic.h"

class VTK_SLICER_BASE_LOGIC_EXPORT vtkSlicerCLIModuleLogic : public vtkSlicerModuleLogic
{
public:
  enum CommandLineModuleType
  {
    CommandLineModule,
    SharedObjectModule,
    PythonModule
  };
 
  static vtkSlicerCLIModuleLogic* New();
  vtkTypeMacro(vtkSlicerCLIModuleLogic, vtkSlicerModuleLogic);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void SetDefaultModuleDescription(const ModuleDescription& moduleDescription);
  const ModuleDescription& GetDefaultModuleDescription() const;

  bool SetDefaultParameterValue(const std::string& name, const std::string& value);

  std::string GetDefaultParameterValue(const std::string& name) const;

  vtkMRMLCommandLineModuleNode* CreateNode();

  vtkMRMLCommandLineModuleNode* CreateNodeInScene();
 
  // TODO: do we need to observe MRML here?
  virtual void ProcessMrmlEvents(vtkObject* vtkNotUsed(caller), unsigned long vtkNotUsed(event), void* vtkNotUsed(callData)) {}

  virtual void DeleteTemporaryFilesOn();
  virtual void DeleteTemporaryFilesOff();
  void SetDeleteTemporaryFiles(int value);
  int GetDeleteTemporaryFiles() const;
 
  // Control use of in-memory data transfer by this specific CLI.
  void SetAllowInMemoryTransfer(int value);
  int GetAllowInMemoryTransfer() const;

  void SetHideWindow(int value);
  int GetHideWindow() const;

  virtual void RedirectModuleStreamsOn();
  virtual void RedirectModuleStreamsOff();
  void SetRedirectModuleStreams(int value);
  int GetRedirectModuleStreams() const;

  void Apply(vtkMRMLCommandLineModuleNode* node, bool updateDisplay = true);

  void ApplyAndWait(vtkMRMLCommandLineModuleNode* node, bool updateDisplay = true);
 
  void KillProcesses();
 
  //   void LazyEvaluateModuleTarget(ModuleDescription& moduleDescriptionObject);
  //   void LazyEvaluateModuleTarget(vtkMRMLCommandLineModuleNode* node)
  //     { this->LazyEvaluateModuleTarget(node->GetModuleDescription()); }

  void SetMRMLApplicationLogic(vtkMRMLApplicationLogic* logic) override;
 
protected:
  void SetMRMLSceneInternal(vtkMRMLScene* newScene) override;
  void OnMRMLSceneNodeAdded(vtkMRMLNode* node) override;
  void ProcessMRMLNodesEvents(vtkObject* caller, unsigned long event, void* callData) override;
  void ProcessMRMLLogicsEvents(vtkObject*, long unsigned int, void*) override;
 
  std::string ConstructTemporaryFileName(const std::string& tag,
                                         const std::string& type,
                                         const std::string& name,
                                         const std::vector<std::string>& extensions,
                                         CommandLineModuleType commandType);
  std::string ConstructTemporarySceneFileName(vtkMRMLScene* scene);
  std::string FindHiddenNodeID(const ModuleDescription& d, const ModuleParameter& p);
 
  // The method that runs the command line module
  void ApplyTask(void* clientdata);
 
  // Communicate progress back to the node
  static void ProgressCallback(void*);

  static void RemoveProgressInfoFromProcessOutput(std::string& text);

  bool IsCommandLineModuleNodeUpdatingDisplay(vtkMRMLCommandLineModuleNode* commandLineModuleNode) const;

  void AutoRun(vtkMRMLCommandLineModuleNode* cliNode);

  enum Events
  {
    RequestHierarchyEditEvent = vtkCommand::UserEvent + 1
  };
 
  // Add a model hierarchy node and all its descendants to a scene (miniscene to sent to a CLI).
  // The mapping of ids from the original scene to the mini scene is put in (added to) sceneToMiniSceneMap.
  // Any files that will be created by writing out the miniscene are added to filesToDelete (i.e. models)
  void AddCompleteModelHierarchyToMiniScene(vtkMRMLScene*, vtkMRMLModelHierarchyNode*, MRMLIDMap* sceneToMiniSceneMap, std::set<std::string>& filesToDelete);
 
  int GetCoordinateSystemFromString(const char* coordinateSystemStr) const;
 
private:
  vtkSlicerCLIModuleLogic();
  ~vtkSlicerCLIModuleLogic() override;
  vtkSlicerCLIModuleLogic(const vtkSlicerCLIModuleLogic&) = delete;
  void operator=(const vtkSlicerCLIModuleLogic&) = delete;
 
  class vtkInternal;
  vtkInternal* Internal;
};
 
#endif