vtkMRMLOperationProgress.h

Go to the documentation of this file.

/*==============================================================================
 
  Program: 3D Slicer
 
  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.
 
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
 
==============================================================================*/
 
#ifndef __vtkMRMLOperationProgress_h
#define __vtkMRMLOperationProgress_h
 
#include "vtkMRMLLogicExport.h"
 
#include <vtkObject.h>
 
#include <string>

class VTK_MRML_LOGIC_EXPORT vtkMRMLOperationProgress : public vtkObject
{
public:
  static vtkMRMLOperationProgress* New();
  vtkTypeMacro(vtkMRMLOperationProgress, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkGetMacro(Progress, double);
  vtkSetClampMacro(Progress, double, 0.0, 1.0);

  vtkGetMacro(Title, std::string);
  vtkSetMacro(Title, std::string);

  vtkGetMacro(ProgressText, std::string);
  vtkSetMacro(ProgressText, std::string);

  vtkGetMacro(NumberOfFiles, int);
  vtkSetMacro(NumberOfFiles, int);

  vtkGetMacro(CurrentFileIndex, int);
  vtkSetMacro(CurrentFileIndex, int);

  vtkGetMacro(CurrentFileProgress, double);
  vtkSetClampMacro(CurrentFileProgress, double, -1.0, 1.0);


  vtkGetMacro(ProgressRangeMinimum, double);
  vtkSetClampMacro(ProgressRangeMinimum, double, 0.0, 1.0);
  vtkGetMacro(ProgressRangeMaximum, double);
  vtkSetClampMacro(ProgressRangeMaximum, double, 0.0, 1.0);
  vtkGetMacro(CurrentFileRangeMinimum, double);
  vtkSetClampMacro(CurrentFileRangeMinimum, double, 0.0, 1.0);
  vtkGetMacro(CurrentFileRangeMaximum, double);
  vtkSetClampMacro(CurrentFileRangeMaximum, double, 0.0, 1.0);

  vtkGetMacro(Abortable, bool);
  vtkSetMacro(Abortable, bool);
  vtkBooleanMacro(Abortable, bool);

  vtkGetMacro(AbortExecute, bool);
  vtkSetMacro(AbortExecute, bool);
  vtkBooleanMacro(AbortExecute, bool);
 
protected:
  vtkMRMLOperationProgress();
  ~vtkMRMLOperationProgress() override;
 
  double Progress{ 0.0 };
  std::string Title;
  std::string ProgressText;
  int NumberOfFiles{ 1 };
  int CurrentFileIndex{ 0 };
  double CurrentFileProgress{ -1.0 };
  double ProgressRangeMinimum{ 0.0 };
  double ProgressRangeMaximum{ 1.0 };
  double CurrentFileRangeMinimum{ 0.0 };
  double CurrentFileRangeMaximum{ 1.0 };
  bool Abortable{ false };
  bool AbortExecute{ false };
 
private:
  vtkMRMLOperationProgress(const vtkMRMLOperationProgress&) = delete;
  void operator=(const vtkMRMLOperationProgress&) = delete;
};
 
#endif