Medical Imaging Interaction Toolkit  2018.4.99-08619e4f
Medical Imaging Interaction Toolkit
mitk::ToolCommand Class Reference

A command to get tool process feedback. More...

#include <mitkToolCommand.h>

Inheritance diagram for mitk::ToolCommand:
Collaboration diagram for mitk::ToolCommand:

Public Types

typedef ToolCommand Self
 
typedef itk::Command Superclass
 
typedef itk::SmartPointer< SelfPointer
 

Public Member Functions

Pointer Clone () const
 
void Execute (itk::Object *caller, const itk::EventObject &event) override
 Reacts on events from ITK filters. More...
 
void Execute (const itk::Object *object, const itk::EventObject &event) override
 Not implemented... More...
 
void AddStepsToDo (int steps)
 Add new steps to the progress bar. More...
 
void SetProgress (int steps)
 Sets the remaining progress to the progress bar when the optimization process is done. More...
 
double GetCurrentProgressValue ()
 Returns the current progress value. More...
 
void SetStopProcessing (bool value)
 Sets the stop processing flag, which is used to call ... More...
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 ToolCommand ()
 

Detailed Description

A command to get tool process feedback.

See also
ProgressBar

Definition at line 28 of file mitkToolCommand.h.

Member Typedef Documentation

◆ Pointer

◆ Self

Definition at line 31 of file mitkToolCommand.h.

◆ Superclass

typedef itk::Command mitk::ToolCommand::Superclass

Definition at line 32 of file mitkToolCommand.h.

Constructor & Destructor Documentation

◆ ToolCommand()

mitk::ToolCommand::ToolCommand ( )
protected

Definition at line 16 of file mitkToolCommand.cpp.

Member Function Documentation

◆ AddStepsToDo()

void mitk::ToolCommand::AddStepsToDo ( int  steps)

Add new steps to the progress bar.

Definition at line 69 of file mitkToolCommand.cpp.

References mitk::ProgressBar::AddStepsToDo(), and mitk::ProgressBar::GetInstance().

◆ Clone()

Pointer mitk::ToolCommand::Clone ( ) const

◆ Execute() [1/2]

void mitk::ToolCommand::Execute ( itk::Object *  caller,
const itk::EventObject &  event 
)
override

Reacts on events from ITK filters.

Definition at line 20 of file mitkToolCommand.cpp.

References mitk::ProgressBar::GetInstance(), and mitk::ProgressBar::Progress().

◆ Execute() [2/2]

void mitk::ToolCommand::Execute ( const itk::Object *  object,
const itk::EventObject &  event 
)
override

Not implemented...

Definition at line 65 of file mitkToolCommand.cpp.

◆ GetCurrentProgressValue()

double mitk::ToolCommand::GetCurrentProgressValue ( )

Returns the current progress value.

Definition at line 79 of file mitkToolCommand.cpp.

◆ New()

◆ SetProgress()

void mitk::ToolCommand::SetProgress ( int  steps)

Sets the remaining progress to the progress bar when the optimization process is done.

Definition at line 74 of file mitkToolCommand.cpp.

References mitk::ProgressBar::GetInstance(), and mitk::ProgressBar::Progress().

◆ SetStopProcessing()

void mitk::ToolCommand::SetStopProcessing ( bool  value)

Sets the stop processing flag, which is used to call ...

Definition at line 84 of file mitkToolCommand.cpp.


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