Medical Imaging Interaction Toolkit  2018.4.99-b585543d
Medical Imaging Interaction Toolkit

Helper class to step through a list. More...

#include <mitkMultiStepper.h>

Inheritance diagram for mitk::MultiStepper:
Collaboration diagram for mitk::MultiStepper:

Public Member Functions

 mitkClassMacro (MultiStepper, Stepper)
 
Pointer Clone () const
 
void AddStepper (Stepper::Pointer stepper, unsigned int repeat=1)
 
void RemoveStepper (Stepper::Pointer stepper, unsigned int repeat=1)
 
void SetPos (unsigned int pos) override
 
void SetSteps (const unsigned int steps) override
 
- Public Member Functions inherited from mitk::Stepper
virtual std::vector< std::string > GetClassHierarchy () const
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
virtual unsigned int GetPos () const
 
virtual unsigned int GetSteps () const
 
virtual bool GetAutoRepeat () const
 
virtual void SetAutoRepeat (bool _arg)
 
virtual void AutoRepeatOn ()
 
virtual void AutoRepeatOff ()
 
virtual void SetPingPong (bool _arg)
 
virtual bool GetPingPong () const
 
virtual void PingPongOn ()
 
virtual void PingPongOff ()
 
virtual void SetInverseDirection (bool _arg)
 
virtual bool GetInverseDirection () const
 
virtual void InverseDirectionOn ()
 
virtual void InverseDirectionOff ()
 
void SetRange (ScalarType min, ScalarType max)
 
void InvalidateRange ()
 
ScalarType GetRangeMin () const
 
ScalarType GetRangeMax () const
 
bool HasValidRange () const
 
void RemoveRange ()
 
bool HasRange () const
 
void SetUnitName (const char *unitName)
 
const char * GetUnitName () const
 
void RemoveUnitName ()
 
bool HasUnitName () const
 
virtual void Next ()
 
virtual void Previous ()
 
virtual void MoveSlice (int sliceDelta)
 
virtual void First ()
 
virtual void Last ()
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from mitk::Stepper
static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 

Protected Types

typedef std::set< Stepper::PointerStepperSet
 
typedef std::map< Stepper::Pointer, unsigned int > ScaleFactorMap
 

Protected Member Functions

 MultiStepper ()
 
 ~MultiStepper () override
 
void UpdateStepCount ()
 
- Protected Member Functions inherited from mitk::Stepper
 Stepper ()
 
 ~Stepper () override
 
void Increase ()
 
void Decrease ()
 

Protected Attributes

StepperSet m_SubSteppers
 
ScaleFactorMap m_ScaleFactors
 
Stepper::Pointer m_LargestRangeStepper
 
- Protected Attributes inherited from mitk::Stepper
unsigned int m_Pos
 
unsigned int m_Steps
 
bool m_AutoRepeat
 
bool m_PingPong
 
bool m_InverseDirection
 
ScalarType m_RangeMin
 
ScalarType m_RangeMax
 
bool m_RangeValid
 
bool m_HasRange
 
std::string m_UnitName
 
bool m_HasUnitName
 

Additional Inherited Members

- Public Types inherited from mitk::Stepper
typedef Stepper Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

Detailed Description

Helper class to step through a list.

A helper class to step through a list. Does not contain the list, just the position in the list (between 0 and GetSteps()). Provides methods like First (go to the first element), Next (go to the next one), etc.

Definition at line 33 of file mitkMultiStepper.h.

Member Typedef Documentation

◆ ScaleFactorMap

typedef std::map<Stepper::Pointer, unsigned int> mitk::MultiStepper::ScaleFactorMap
protected

Definition at line 52 of file mitkMultiStepper.h.

◆ StepperSet

typedef std::set<Stepper::Pointer> mitk::MultiStepper::StepperSet
protected

Definition at line 51 of file mitkMultiStepper.h.

Constructor & Destructor Documentation

◆ MultiStepper()

mitk::MultiStepper::MultiStepper ( )
protected

Definition at line 16 of file mitkMultiStepper.cpp.

◆ ~MultiStepper()

mitk::MultiStepper::~MultiStepper ( )
overrideprotected

Definition at line 20 of file mitkMultiStepper.cpp.

Member Function Documentation

◆ AddStepper()

void mitk::MultiStepper::AddStepper ( Stepper::Pointer  stepper,
unsigned int  repeat = 1 
)

Definition at line 23 of file mitkMultiStepper.cpp.

References m_ScaleFactors, m_SubSteppers, and UpdateStepCount().

◆ Clone()

Pointer mitk::MultiStepper::Clone ( ) const

◆ mitkClassMacro()

mitk::MultiStepper::mitkClassMacro ( MultiStepper  ,
Stepper   
)

◆ New()

static Pointer mitk::MultiStepper::New ( )
static

Referenced by mitkMultiStepperTest().

◆ RemoveStepper()

void mitk::MultiStepper::RemoveStepper ( Stepper::Pointer  stepper,
unsigned int  repeat = 1 
)

Definition at line 29 of file mitkMultiStepper.cpp.

References m_ScaleFactors, m_SubSteppers, and UpdateStepCount().

◆ SetPos()

void mitk::MultiStepper::SetPos ( unsigned int  pos)
overridevirtual

Reimplemented from mitk::Stepper.

Definition at line 56 of file mitkMultiStepper.cpp.

References mitk::Stepper::GetSteps(), m_ScaleFactors, m_SubSteppers, and mitk::Stepper::SetPos().

◆ SetSteps()

void mitk::MultiStepper::SetSteps ( const unsigned int  steps)
overridevirtual

Reimplemented from mitk::Stepper.

Definition at line 69 of file mitkMultiStepper.cpp.

◆ UpdateStepCount()

void mitk::MultiStepper::UpdateStepCount ( )
protected

Member Data Documentation

◆ m_LargestRangeStepper

Stepper::Pointer mitk::MultiStepper::m_LargestRangeStepper
protected

Definition at line 55 of file mitkMultiStepper.h.

Referenced by UpdateStepCount().

◆ m_ScaleFactors

ScaleFactorMap mitk::MultiStepper::m_ScaleFactors
protected

Definition at line 54 of file mitkMultiStepper.h.

Referenced by AddStepper(), RemoveStepper(), SetPos(), and UpdateStepCount().

◆ m_SubSteppers

StepperSet mitk::MultiStepper::m_SubSteppers
protected

Definition at line 53 of file mitkMultiStepper.h.

Referenced by AddStepper(), RemoveStepper(), SetPos(), and UpdateStepCount().


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