my::algo Class Reference

A simple configurable algorithm class. More...

#include </doc/BxOCD/tutorial/my/algo.h>

Public Member Functions
	algo ()
	Default constructor. More...
void	initialize (const datatools::properties &config_)
	Main initialization from a container of configuration parameters. More...
void	run ()
	Run the algorithm. More...
void	reset ()
	Reset the algorithm. More...

Detailed Description

A simple configurable algorithm class.

Constructor & Destructor Documentation

algo()

my::algo::algo

(

)

Default constructor.

The algorithm object is constructed with its status set to not-initialized.

Member Function Documentation

initialize()

void my::algo::initialize

(

const datatools::properties &

config_

)

Main initialization from a container of configuration parameters.

The algorithm object can be initialized only if its status is not-initialized.

reset()

void my::algo::reset

(

)

Reset the algorithm.

The algorithm object can be reset only if its status is initialized.

run()

void my::algo::run

(

)

Run the algorithm.

The algorithm object can run only if its status is initialized.

---

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

• /doc/BxOCD/tutorial/my/algo.h
• /doc/BxOCD/tutorial/my/algo.cc