Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit

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

#include <mitkStepper.h>

Inheritance diagram for mitk::Stepper:
Collaboration diagram for mitk::Stepper:

Public Types

typedef Stepper Self
typedef itk::Object Superclass
typedef itk::SmartPointer< SelfPointer
typedef itk::SmartPointer< const SelfConstPointer

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const
virtual const char * GetClassName () const
Pointer Clone () const
virtual unsigned int GetPos () const
virtual void SetPos (unsigned int pos)
virtual unsigned int GetSteps () const
virtual void SetSteps (unsigned int _arg)
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 First ()
virtual void Last ()

Static Public Member Functions

static const char * GetStaticNameOfClass ()
static Pointer New ()

Protected Member Functions

 Stepper ()
virtual ~Stepper ()
void Increase ()
void Decrease ()

Protected Attributes

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

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.

Besides the actual number of steps, the stepper can also hold a stepping range, indicating the scalar values corresponding to the covered steps. For example, steppers are generally used to slice a dataset with a plane; Hereby, Steps indicates the total number of steps (positions) available for the plane, Pos indicates the current step, and Range indicates the physical minimum and maximum values for the plane, in this case a value in mm.

The range can also be supplied with a unit name (a string) which can be used by classes providing information about the stepping (e.g. graphical sliders).

Definition at line 51 of file mitkStepper.h.

Member Typedef Documentation

Definition at line 54 of file mitkStepper.h.

Definition at line 54 of file mitkStepper.h.

Definition at line 54 of file mitkStepper.h.

typedef itk::Object mitk::Stepper::Superclass

Definition at line 54 of file mitkStepper.h.

Constructor & Destructor Documentation

mitk::Stepper::Stepper ( )

Definition at line 19 of file mitkStepper.cpp.

mitk::Stepper::~Stepper ( )

Definition at line 33 of file mitkStepper.cpp.

Member Function Documentation

virtual void mitk::Stepper::AutoRepeatOff ( )
virtual void mitk::Stepper::AutoRepeatOn ( )
Pointer mitk::Stepper::Clone ( ) const
void mitk::Stepper::Decrease ( )

Definition at line 125 of file mitkStepper.cpp.

void mitk::Stepper::First ( )

Definition at line 172 of file mitkStepper.cpp.

virtual bool mitk::Stepper::GetAutoRepeat ( ) const
virtual std::vector<std::string> mitk::Stepper::GetClassHierarchy ( ) const

Definition at line 54 of file mitkStepper.h.

virtual const char* mitk::Stepper::GetClassName ( ) const
virtual bool mitk::Stepper::GetInverseDirection ( ) const
virtual bool mitk::Stepper::GetPingPong ( ) const
mitk::ScalarType mitk::Stepper::GetRangeMax ( ) const

Definition at line 58 of file mitkStepper.cpp.

mitk::ScalarType mitk::Stepper::GetRangeMin ( ) const

Definition at line 53 of file mitkStepper.cpp.

static const char* mitk::Stepper::GetStaticNameOfClass ( )

Definition at line 54 of file mitkStepper.h.

virtual unsigned int mitk::Stepper::GetSteps ( ) const
const char * mitk::Stepper::GetUnitName ( ) const

Definition at line 86 of file mitkStepper.cpp.

bool mitk::Stepper::HasRange ( ) const

Definition at line 74 of file mitkStepper.cpp.

bool mitk::Stepper::HasUnitName ( ) const

Definition at line 97 of file mitkStepper.cpp.

bool mitk::Stepper::HasValidRange ( ) const

Definition at line 69 of file mitkStepper.cpp.

void mitk::Stepper::Increase ( )

Definition at line 102 of file mitkStepper.cpp.

void mitk::Stepper::InvalidateRange ( )

Definition at line 46 of file mitkStepper.cpp.

virtual void mitk::Stepper::InverseDirectionOff ( )
virtual void mitk::Stepper::InverseDirectionOn ( )
void mitk::Stepper::Last ( )

Definition at line 177 of file mitkStepper.cpp.

static Pointer mitk::Stepper::New ( )
void mitk::Stepper::Next ( )
virtual void mitk::Stepper::PingPongOff ( )
virtual void mitk::Stepper::PingPongOn ( )
void mitk::Stepper::Previous ( )
void mitk::Stepper::RemoveRange ( )

Definition at line 63 of file mitkStepper.cpp.

void mitk::Stepper::RemoveUnitName ( )

Definition at line 91 of file mitkStepper.cpp.

virtual void mitk::Stepper::SetAutoRepeat ( bool  _arg)
virtual void mitk::Stepper::SetInverseDirection ( bool  _arg)

If set to true, the Next() decreases the stepper and Previous() decreases it

virtual void mitk::Stepper::SetPingPong ( bool  _arg)

Causes the stepper to shift direction when the boundary is reached

void mitk::Stepper::SetRange ( ScalarType  min,
ScalarType  max 

Definition at line 37 of file mitkStepper.cpp.

References max(), and min().

virtual void mitk::Stepper::SetSteps ( unsigned int  _arg)

Reimplemented in mitk::MultiStepper.

void mitk::Stepper::SetUnitName ( const char *  unitName)

Definition at line 79 of file mitkStepper.cpp.

Member Data Documentation

bool mitk::Stepper::m_AutoRepeat

Definition at line 130 of file mitkStepper.h.

bool mitk::Stepper::m_HasRange

Definition at line 138 of file mitkStepper.h.

bool mitk::Stepper::m_HasUnitName

Definition at line 141 of file mitkStepper.h.

bool mitk::Stepper::m_InverseDirection

Definition at line 133 of file mitkStepper.h.

bool mitk::Stepper::m_PingPong

Definition at line 132 of file mitkStepper.h.

unsigned int mitk::Stepper::m_Pos

Definition at line 126 of file mitkStepper.h.

ScalarType mitk::Stepper::m_RangeMax

Definition at line 136 of file mitkStepper.h.

ScalarType mitk::Stepper::m_RangeMin

Definition at line 135 of file mitkStepper.h.

bool mitk::Stepper::m_RangeValid

Definition at line 137 of file mitkStepper.h.

unsigned int mitk::Stepper::m_Steps

Definition at line 128 of file mitkStepper.h.

std::string mitk::Stepper::m_UnitName

Definition at line 140 of file mitkStepper.h.

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