rtk::IterationCommand< TCaller > Class Template Reference

#include <rtkIterationCommands.h>

Inheritance diagram for rtk::IterationCommand< TCaller >:

Collaboration diagram for rtk::IterationCommand< TCaller >:

Public Types
typedef itk::SmartPointer< Self >	Pointer
typedef IterationCommand	Self
typedef itk::Command	Superclass

Public Member Functions
void	Execute (itk::Object *caller, const itk::EventObject &event) override
void	Execute (const itk::Object *caller, const itk::EventObject &event) override
virtual void	SetTriggerEvery (unsigned int _arg)

Protected Member Functions
virtual void	End (const TCaller *)
virtual void	Run (const TCaller *caller)=0

Protected Attributes
unsigned int	m_IterationCount = 0
unsigned int	m_TriggerEvery = 1

Detailed Description

template<typename TCaller>
class rtk::IterationCommand< TCaller >

Abstract superclass to all iteration callbacks. Derived classes must implement the Run() method. Run() can be triggered only once in every n iterations.

Author

Aurélien Coussat

Definition at line 38 of file rtkIterationCommands.h.

Member Typedef Documentation

Pointer

template<typename TCaller >

typedef itk::SmartPointer<Self> rtk::IterationCommand< TCaller >::Pointer

Definition at line 44 of file rtkIterationCommands.h.

Self

template<typename TCaller >

typedef IterationCommand rtk::IterationCommand< TCaller >::Self

Standard class typedefs.

Definition at line 42 of file rtkIterationCommands.h.

Superclass

template<typename TCaller >

typedef itk::Command rtk::IterationCommand< TCaller >::Superclass

Definition at line 43 of file rtkIterationCommands.h.

Member Function Documentation

End()

template<typename TCaller >

virtual void rtk::IterationCommand< TCaller >::End ( const TCaller *  )

inlineprotectedvirtual

Callback function executed when filter concludes.

Reimplemented in rtk::VerboseIterationCommand< TCaller >.

Definition at line 89 of file rtkIterationCommands.h.

Execute() [1/2]

template<typename TCaller >

void rtk::IterationCommand< TCaller >::Execute ( itk::Object *  caller, const itk::EventObject &  event  )

inlineoverride

Definition at line 49 of file rtkIterationCommands.h.

Execute() [2/2]

template<typename TCaller >

void rtk::IterationCommand< TCaller >::Execute ( const itk::Object *  caller, const itk::EventObject &  event  )

inlineoverride

Definition at line 55 of file rtkIterationCommands.h.

Run()

template<typename TCaller >

virtual void rtk::IterationCommand< TCaller >::Run ( const TCaller *  caller )

protectedpure virtual

Callback function to be redefined by derived classes.

Implemented in rtk::OutputIterationCommand< TCaller, TOutputImage >, and rtk::VerboseIterationCommand< TCaller >.

SetTriggerEvery()

template<typename TCaller >

virtual void rtk::IterationCommand< TCaller >::SetTriggerEvery ( unsigned int  _arg )

virtual

Member Data Documentation

m_IterationCount

template<typename TCaller >

unsigned int rtk::IterationCommand< TCaller >::m_IterationCount = 0

protected

How many times this command has been executed.

Definition at line 78 of file rtkIterationCommands.h.

m_TriggerEvery

template<typename TCaller >

unsigned int rtk::IterationCommand< TCaller >::m_TriggerEvery = 1

protected

Trigger the callback every n iterations.

Definition at line 81 of file rtkIterationCommands.h.

---

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

• rtkIterationCommands.h