vtkPluginFilterWatcher.h

Go to the documentation of this file.

#ifndef __vtkPluginFilterWatcher_h
#define __vtkPluginFilterWatcher_h

// ModuleDescriptionParser includes
#include <ModuleProcessInformation.h>

// VTK includes
#include <vtkCommand.h>
#include <vtkAlgorithm.h>

#include "vtkSlicerBaseCLIExport.h"

// STD includes
#include <string>

class vtkPluginWatcherStart;
class vtkPluginWatcherEnd;
class vtkPluginWatcherProgress;

class VTK_SLICER_BASE_CLI_EXPORT vtkPluginFilterWatcher
{
public:
  vtkPluginFilterWatcher(vtkAlgorithm* o,
                         const char *comment="",
                         ModuleProcessInformation *inf=nullptr,
                         double fraction = 1.0,
                         double start = 0.0);

  virtual ~vtkPluginFilterWatcher();

  const char *GetNameOfClass ()
    {
      return (Process ? Process->GetClassName() : "None");
    }

  void QuietOn() { this->SetQuiet(true);};
  void QuietOff() { this->SetQuiet(false);};

  vtkAlgorithm *GetProcess () {return Process;};

  void SetSteps(int val) {Steps=val;};
  int GetSteps() {return Steps;};

  double GetStart() {return this->Start;};
  double GetFraction() {return this->Fraction;};

  void SetQuiet(bool val);
  bool GetQuiet() {return Quiet;};

  std::string GetComment() {return Comment;};

  ModuleProcessInformation *GetProcessInformation() {return this->ProcessInformation;};


protected:

private:
  int Steps;
  bool Quiet;
  std::string Comment;
  vtkAlgorithm *Process;

  ModuleProcessInformation *ProcessInformation;
  double Fraction;
  double Start;

  vtkPluginWatcherStart *StartFilterCommand;
  vtkPluginWatcherEnd *EndFilterCommand;
  vtkPluginWatcherProgress *ProgressFilterCommand;

  unsigned long StartTag;
  unsigned long EndTag;
  unsigned long ProgressTag;
};

#endif