Step< T > Class Template Reference

#include <step.h>

Inheritance diagram for Step< T >:

Public Member Functions
virtual STD_string	label () const =0
virtual STD_string	description () const =0
virtual T *	allocate () const =0
virtual void	init ()=0
T *	clone () const
void	set_args (const STD_string &argstr)
STD_string	args_description () const
STD_string	args_values () const
unsigned int	numof_args () const
void	append_opts (LDRblock &parblock)

Protected Member Functions
void	append_arg (LDRbase &arg, const STD_string &arglabel)

Detailed Description

template<class T>
class Step< T >

Base class for all steps (functors). The template argument is the type of the specialized, derived class.

Definition at line 35 of file odindata/step.h.

Member Function Documentation

allocate()

template<class T >

virtual T* Step< T >::allocate ( ) const

pure virtual

Overload this function to allocate an empty object of the step.

append_arg()

template<class T >

void Step< T >::append_arg ( LDRbase &  arg, const STD_string &  arglabel  )

protected

Append step argument, to be used in init() of each step.

Definition at line 76 of file step_code.h.

append_opts()

template<class T >

void Step< T >::append_opts

(

LDRblock &

parblock

)

Append arguments of the functor to parblock.

Definition at line 70 of file step_code.h.

args_description()

template<class T >

STD_string Step< T >::args_description

Returns description of arguments as comma-separated list.

Definition at line 35 of file step_code.h.

args_values()

template<class T >

STD_string Step< T >::args_values

Returns values of arguments as comma-separated list.

Definition at line 56 of file step_code.h.

clone()

template<class T >

T * Step< T >::clone

Clone this step (including its arguments).

Definition at line 6 of file step_code.h.

description()

template<class T >

virtual STD_string Step< T >::description ( ) const

pure virtual

Overload this function to return a brief description of the functor.

init()

template<class T >

virtual void Step< T >::init ( )

pure virtual

Initialize the step, i.e. initiliaze its parameters and append them by 'append_arg'.

label()

template<class T >

virtual STD_string Step< T >::label ( ) const

pure virtual

Overload this function to return a unique label for the functor.

numof_args()

template<class T >

unsigned int Step< T >::numof_args ( ) const

inline

Returns the number of arguments.

Definition at line 85 of file odindata/step.h.

set_args()

template<class T >

void Step< T >::set_args

(

const STD_string &

argstr

)

Overrides the arguments of the functor using a string with comma-separated argument values.

Definition at line 15 of file step_code.h.

---

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

• odindata/step.h
• step_code.h