vtkMRMLCommandLineModuleNode.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.
 
=========================================================================auto=*/
 
#ifndef __vtkMRMLCommandLineModuleNode_h
#define __vtkMRMLCommandLineModuleNode_h

#include <vtkMRMLNode.h>
 
#include "vtkMRMLCLIExport.h"
 
class ModuleDescription;

class VTK_MRML_CLI_EXPORT vtkMRMLCommandLineModuleNode : public vtkMRMLNode
{
public:
  static vtkMRMLCommandLineModuleNode* New();
  vtkTypeMacro(vtkMRMLCommandLineModuleNode, vtkMRMLNode);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  vtkMRMLNode* CreateNodeInstance() override;

  void ReadXMLAttributes(const char** atts) override;

  void WriteXML(ostream& of, int indent) override;

  vtkMRMLCopyContentMacro(vtkMRMLCommandLineModuleNode);

  const char* GetNodeTagName() override { return "CommandLineModule"; }

  enum CLINodeEvent
  {
    ParameterChangedEvent = 17000,
    InputParameterEvent,
    AutoRunEvent,
    StatusModifiedEvent
  };

  const ModuleDescription& GetModuleDescription() const;
  ModuleDescription& GetModuleDescription();
  std::string GetModuleDescriptionAsString() const;
  void SetModuleDescription(const ModuleDescription& description);
 
  enum StatusType
  {
    Idle = 0x00,
    Scheduled = 0x01,
    Running = 0x02,
    Cancelling = 0x04,
    Cancelled = 0x08,
    Completing = 0x10,
    Completed = 0x20,
    ErrorsMask = 0x40,
    CompletedWithErrors = Completed | ErrorsMask,
    BusyMask = Scheduled | Running | Cancelling | Completing
  };

  void SetStatus(int status, bool modify = true);
  int GetStatus() const;

  const char* GetStatusString() const;

  std::string GetDisplayableStatusString() const;


  void StartContinuousOutputUpdate();
  void EndContinuousOutputUpdate();
  bool IsContinuousOutputUpdate();


  void SetOutputText(const std::string& text, bool modify = true);
  std::string GetOutputText() const;


  void SetErrorText(const std::string& text, bool modify = true);
  std::string GetErrorText() const;

  bool IsBusy() const;
 
  int GetProgress() const;

  void Cancel();

  enum AutoRunMode
  {
    AutoRunCancelsRunningProcess = 0x01,
    AutoRunOnChangedParameter = 0x10,
    AutoRunOnModifiedInputEvent = 0x20,
    AutoRunOnOtherInputEvents = 0x40,
    AutoRunOnAnyInputEvent = AutoRunOnModifiedInputEvent | AutoRunOnOtherInputEvents,
    // <- add here new options
    AutoRunEnabledMask = AutoRunOnChangedParameter | AutoRunOnAnyInputEvent
  };

  void SetAutoRun(bool enable);

  bool GetAutoRun() const;

  void SetAutoRunMode(int autoRunMode);

  int GetAutoRunMode() const;

  void SetAutoRunDelay(unsigned int delayInMs);

  unsigned int GetAutoRunDelay() const;

  vtkMTimeType GetLastRunTime() const;

  vtkMTimeType GetParameterMTime() const;

  vtkMTimeType GetInputMTime() const;

  bool ReadParameterFile(const std::string& filename);

  bool WriteParameterFile(const std::string& filename, bool withHandlesToBulkParameters = true);

  bool SetParameterAsNode(const char* name, vtkMRMLNode* value);
  bool SetParameterAsString(const char* name, const std::string& value);
  bool SetParameterAsInt(const char* name, int value);
  bool SetParameterAsBool(const char* name, bool value);
  bool SetParameterAsDouble(const char* name, double value);
  bool SetParameterAsFloat(const char* name, float value);
 
  std::string GetParameterAsString(const char* name) const;
 
  void SetModuleDescription(const char* name);
  std::string GetModuleVersion() const;
  std::string GetModuleTitle() const;
  std::string GetModuleTarget() const;
  std::string GetModuleType() const;
  bool IsValidGroupId(unsigned int group) const;
  bool IsValidParamId(unsigned int group, unsigned int param) const;
  unsigned int GetNumberOfParameterGroups() const;
  unsigned int GetNumberOfParametersInGroup(unsigned int group) const;
  std::string GetParameterGroupLabel(unsigned int group) const;
  std::string GetParameterGroupDescription(unsigned int group) const;
  std::string GetParameterGroupAdvanced(unsigned int group) const;
  std::string GetParameterTag(unsigned int group, unsigned int param) const;
  std::string GetParameterType(unsigned int group, unsigned int param) const;
  std::string GetParameterArgType(unsigned int group, unsigned int param) const;
  std::string GetParameterName(unsigned int group, unsigned int param) const;
  std::string GetParameterLongFlag(unsigned int group, unsigned int param) const;
  std::string GetParameterLabel(unsigned int group, unsigned int param) const;
  std::string GetParameterConstraints(unsigned int group, unsigned int param) const;
  std::string GetParameterMaximum(unsigned int group, unsigned int param) const;
  std::string GetParameterMinimum(unsigned int group, unsigned int param) const;
  std::string GetParameterDescription(unsigned int group, unsigned int param) const;
  std::string GetParameterChannel(unsigned int group, unsigned int param) const;
  std::string GetParameterIndex(unsigned int group, unsigned int param) const;
  std::string GetParameterDefault(unsigned int group, unsigned int param) const;
  std::string GetParameterValue(unsigned int group, unsigned int param) const;
  std::string GetParameterFlag(unsigned int group, unsigned int param) const;
  std::string GetParameterMultiple(unsigned int group, unsigned int param) const;
  std::string GetParameterFileExtensions(unsigned int group, unsigned int param) const;
  std::string GetParameterCoordinateSystem(unsigned int group, unsigned int param) const;

  bool IsInputDefaultValue(const std::string& value) const;

  static int GetNumberOfRegisteredModules();
  static const char* GetRegisteredModuleNameByIndex(int idx);
  static void RegisterModuleDescription(ModuleDescription md);
  static bool HasRegisteredModule(const std::string& name);
  static ModuleDescription GetRegisteredModuleDescription(const std::string& name);

  void Modified() override;
 
protected:
  void AbortProcess();
  void ProcessMRMLEvents(vtkObject* caller, unsigned long event, void* callData) override;
 
  int ContinuousOutputUpdateInProgressCount{ 0 };
 
private:
  vtkMRMLCommandLineModuleNode();
  ~vtkMRMLCommandLineModuleNode() override;
  vtkMRMLCommandLineModuleNode(const vtkMRMLCommandLineModuleNode&) = delete;
  void operator=(const vtkMRMLCommandLineModuleNode&) = delete;
 
  class vtkInternal;
  vtkInternal* Internal;
};
 
#endif