Medical Imaging Interaction Toolkit  2018.4.99-389bf124
Medical Imaging Interaction Toolkit
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
mitk::ProgressBar Class Reference
MITK Modules » Core » Interaction and Undo Classes » Interaction Classes

Sending a message to the applications ProgressBar. More...

#include <mitkProgressBar.h>

Inheritance diagram for mitk::ProgressBar:
Inheritance graph
[legend]
Collaboration diagram for mitk::ProgressBar:
Collaboration graph
[legend]

Public Member Functions

virtual const char * GetClassName () const
 
void RegisterImplementationInstance (ProgressBarImplementation *implementation)
 Supply a GUI- dependent ProgressBar. Has to be set by the application to connect the application dependent subclass of mitkProgressBar. More...
 
void UnregisterImplementationInstance (ProgressBarImplementation *implementation)
 
void AddStepsToDo (unsigned int steps)
 Adds steps to totalSteps. More...
 
void Reset ()
 Explicitly reset progress bar. More...
 
void Progress (unsigned int steps=1)
 Sets the current amount of progress to current progress + steps. More...
 
void SetPercentageVisible (bool visible)
 Sets whether the current progress value is displayed. More...
 

Static Public Member Functions

static ProgressBar * GetInstance ()
 static method to get the GUI dependent ProgressBar-instance so the methods for steps to do and progress can be called No reference counting, cause of decentral static use! More...
 

Protected Types

typedef std::vector< ProgressBarImplementation * > ProgressBarImplementationsList
 
typedef ProgressBarImplementationsList::iterator ProgressBarImplementationsListIterator
 

Protected Member Functions

 ProgressBar ()
 
 ~ProgressBar () override
 

Protected Attributes

ProgressBarImplementationsList m_Implementations
 

Static Protected Attributes

static ProgressBar * m_Instance
 

Detailed Description

Sending a message to the applications ProgressBar.

Holds a GUI dependent ProgressBarImplementation and sends the progress further. All mitk-classes use this class to display progress on GUI-ProgressBar. The mainapplication has to set the internal held ProgressBarImplementation with SetImplementationInstance(..).

Definition at line 29 of file mitkProgressBar.h.

Member Typedef Documentation

◆ ProgressBarImplementationsList

typedef std::vector<ProgressBarImplementation *> mitk::ProgressBar::ProgressBarImplementationsList
protected

Definition at line 65 of file mitkProgressBar.h.

◆ ProgressBarImplementationsListIterator

typedef ProgressBarImplementationsList::iterator mitk::ProgressBar::ProgressBarImplementationsListIterator
protected

Definition at line 66 of file mitkProgressBar.h.

Constructor & Destructor Documentation

◆ ProgressBar()

mitk::ProgressBar::ProgressBar ( )
protected

Definition at line 136 of file mitkProgressBar.cpp.

Referenced by GetInstance().

◆ ~ProgressBar()

mitk::ProgressBar::~ProgressBar ( )
overrideprotected

Definition at line 137 of file mitkProgressBar.cpp.

Member Function Documentation

◆ AddStepsToDo()

void mitk::ProgressBar::AddStepsToDo ( unsigned int  steps)

Adds steps to totalSteps.

Adds steps to totalSteps.

Definition at line 68 of file mitkProgressBar.cpp.

References m_Implementations.

Referenced by QmitkSliceBasedInterpolatorWidget::AcceptAllInterpolations(), QmitkSlicesInterpolator::AcceptAllInterpolations(), mitk::ToolCommand::AddStepsToDo(), mitk::ManualSegmentationToSurfaceFilter::GenerateData(), mitk::ContourModelSetToImageFilter::GenerateData(), mitk::ImageToSurfaceFilter::GenerateData(), mitk::SurfaceInterpolationController::Interpolate(), mitk::IOUtil::Load(), mitk::SceneReaderV1::LoadScene(), QmitkSlicesInterpolator::OnAccept3DInterpolationClicked(), mitk::SegmentationsProcessingTool::ProcessAllObjects(), mitk::CreateSurfaceTool::ProcessOneWorkingData(), mitk::CalculateGrayValueStatisticsTool::ProcessOneWorkingData(), QmitkExtFileSaveProjectAction::Run(), mitk::IOUtil::Save(), mitk::SceneIO::SaveScene(), QmitkTrackingDeviceConfigurationWidgetScanPortsWorker::ScanPortsThreadFunc(), QmitkTrackingDeviceConfigurationWidgetConnectionWorker::TestConnectionThreadFunc(), and mitk::AnisotropicIterativeClosestPointRegistration::Update().

◆ GetClassName()

virtual const char* mitk::ProgressBar::GetClassName ( ) const
virtual

◆ GetInstance()

ProgressBar * mitk::ProgressBar::GetInstance ( )
static

static method to get the GUI dependent ProgressBar-instance so the methods for steps to do and progress can be called No reference counting, cause of decentral static use!

Get the instance of this ProgressBar

Definition at line 106 of file mitkProgressBar.cpp.

References m_Instance, and ProgressBar().

Referenced by QmitkSliceBasedInterpolatorWidget::AcceptAllInterpolations(), QmitkSlicesInterpolator::AcceptAllInterpolations(), mitk::ToolCommand::AddStepsToDo(), mitk::ImageToSurfaceFilter::CreateSurface(), mitk::ToolCommand::Execute(), mitk::FeatureBasedEdgeDetectionFilter::GenerateData(), mitk::ManualSegmentationToSurfaceFilter::GenerateData(), mitk::ContourModelSetToImageFilter::GenerateData(), mitk::ImageToSurfaceFilter::GenerateData(), mitk::ImageToContourFilter::GenerateData(), mitk::ComputeContourSetNormalsFilter::GenerateData(), mitk::ReduceContourSetFilter::GenerateData(), mitk::CreateDistanceImageFromSurfaceFilter::GenerateData(), mitk::SurfaceInterpolationController::Interpolate(), mitk::IOUtil::Load(), mitk::SceneReaderV1::LoadScene(), QmitkSlicesInterpolator::OnAccept3DInterpolationClicked(), QmitkWatershedToolGUI::OnCreateSegmentation(), mitk::CreateSurfaceTool::OnSurfaceCalculationDone(), mitk::SegmentationsProcessingTool::ProcessAllObjects(), mitk::CreateSurfaceTool::ProcessOneWorkingData(), mitk::CalculateGrayValueStatisticsTool::ProcessOneWorkingData(), QmitkProgressBar::QmitkProgressBar(), QmitkExtFileSaveProjectAction::Run(), QmitkAdaptiveRegionGrowingToolGUI::RunSegmentation(), mitk::IOUtil::Save(), mitk::SceneIO::SaveScene(), QmitkTrackingDeviceConfigurationWidgetScanPortsWorker::ScanPortsThreadFunc(), mitk::ToolCommand::SetProgress(), QmitkTrackingDeviceConfigurationWidgetConnectionWorker::TestConnectionThreadFunc(), mitk::ShowSegmentationAsSmoothedSurface::ThreadedUpdateFunction(), mitk::AnisotropicIterativeClosestPointRegistration::Update(), and QmitkProgressBar::~QmitkProgressBar().

◆ Progress()

void mitk::ProgressBar::Progress ( unsigned int  steps = 1)

Sets the current amount of progress to current progress + steps.

Parameters

Definition at line 30 of file mitkProgressBar.cpp.

References m_Implementations.

Referenced by QmitkSliceBasedInterpolatorWidget::AcceptAllInterpolations(), QmitkSlicesInterpolator::AcceptAllInterpolations(), mitk::ImageToSurfaceFilter::CreateSurface(), mitk::ToolCommand::Execute(), mitk::FeatureBasedEdgeDetectionFilter::GenerateData(), mitk::ManualSegmentationToSurfaceFilter::GenerateData(), mitk::ContourModelSetToImageFilter::GenerateData(), mitk::ImageToSurfaceFilter::GenerateData(), mitk::ImageToContourFilter::GenerateData(), mitk::ComputeContourSetNormalsFilter::GenerateData(), mitk::ReduceContourSetFilter::GenerateData(), mitk::CreateDistanceImageFromSurfaceFilter::GenerateData(), mitk::SurfaceInterpolationController::Interpolate(), mitk::IOUtil::Load(), mitk::SceneReaderV1::LoadScene(), QmitkSlicesInterpolator::OnAccept3DInterpolationClicked(), QmitkWatershedToolGUI::OnCreateSegmentation(), mitk::CreateSurfaceTool::OnSurfaceCalculationDone(), mitk::SegmentationsProcessingTool::ProcessAllObjects(), mitk::CalculateGrayValueStatisticsTool::ProcessOneWorkingData(), QmitkExtFileSaveProjectAction::Run(), QmitkAdaptiveRegionGrowingToolGUI::RunSegmentation(), mitk::IOUtil::Save(), mitk::SceneIO::SaveScene(), QmitkTrackingDeviceConfigurationWidgetScanPortsWorker::ScanPortsThreadFunc(), mitk::ToolCommand::SetProgress(), QmitkTrackingDeviceConfigurationWidgetConnectionWorker::TestConnectionThreadFunc(), mitk::ShowSegmentationAsSmoothedSurface::ThreadedUpdateFunction(), and mitk::AnisotropicIterativeClosestPointRegistration::Update().

◆ RegisterImplementationInstance()

void mitk::ProgressBar::RegisterImplementationInstance ( ProgressBarImplementation *  implementation)

Supply a GUI- dependent ProgressBar. Has to be set by the application to connect the application dependent subclass of mitkProgressBar.

Set an instance of this; application must do this!See Header!

Definition at line 119 of file mitkProgressBar.cpp.

References m_Implementations.

Referenced by QmitkProgressBar::QmitkProgressBar().

◆ Reset()

void mitk::ProgressBar::Reset ( )

Explicitly reset progress bar.

Explicitely reset progress bar.

Definition at line 49 of file mitkProgressBar.cpp.

References m_Implementations.

Referenced by QmitkSliceBasedInterpolatorWidget::AcceptAllInterpolations().

◆ SetPercentageVisible()

void mitk::ProgressBar::SetPercentageVisible ( bool  visible)

Sets whether the current progress value is displayed.

Sets whether the current progress value is displayed.

Definition at line 87 of file mitkProgressBar.cpp.

References m_Implementations.

◆ UnregisterImplementationInstance()

void mitk::ProgressBar::UnregisterImplementationInstance ( ProgressBarImplementation *  implementation)

Definition at line 127 of file mitkProgressBar.cpp.

References m_Implementations.

Referenced by QmitkProgressBar::~QmitkProgressBar().

Member Data Documentation

◆ m_Implementations

ProgressBarImplementationsList mitk::ProgressBar::m_Implementations
protected

Definition at line 72 of file mitkProgressBar.h.

Referenced by AddStepsToDo(), Progress(), RegisterImplementationInstance(), Reset(), SetPercentageVisible(), and UnregisterImplementationInstance().

◆ m_Instance

ProgressBar * mitk::ProgressBar::m_Instance
staticprotected

Definition at line 74 of file mitkProgressBar.h.

Referenced by GetInstance().

The documentation for this class was generated from the following files: