Step< T > Class Template Reference
[Classes of the ODIN data processing framework (odindata library)]

#include <step.h>

Inheritance diagram for Step< T >:

[legend]Collaboration diagram for Step< T >:

[legend]List of all members.

Public Member Functions
virtual	~Step ()
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)
void	parse_args (int argc, char *argv[])
STD_string	args_description () const
void	append_opts (JcampDxBlock &parblock)
Protected Member Functions
void	append_arg (JcampDxClass &arg, const STD_string &arglabel)
const char *	c_label () const

---

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

template<class T>

virtual STD_string Step< T >::label

(

)

const [pure virtual]

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

template<class T>

virtual STD_string Step< T >::description

(

)

const [pure virtual]

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

template<class T>

virtual T* Step< T >::allocate

(

)

const [pure virtual]

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

template<class T>

virtual void Step< T >::init

(

)

[pure virtual]

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

Implemented in FilterType.

template<class T>

T * Step< T >::clone

(

)

const

Clone this step (including its arguments).

Definition at line 5 of file step_code.h.

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 14 of file step_code.h.

template<class T>

void Step< T >::parse_args	(	int	argc,
		char *	argv[]
	)

Overrides the arguments of the functor using command-line args.

Definition at line 33 of file step_code.h.

template<class T>

STD_string Step< T >::args_description

(

)

const

Returns description of arguments as comma-separated list.

Definition at line 38 of file step_code.h.

template<class T>

void Step< T >::append_opts

(

JcampDxBlock &

parblock

)

Append arguments of functor to parblock.

Definition at line 50 of file step_code.h.

template<class T>

void Step< T >::append_arg	(	JcampDxClass &	arg,
		const STD_string &	arglabel
	)			[protected]

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

Definition at line 56 of file step_code.h.

---

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

• odindata/step.h
• step_code.h

---