===== Dummy module =====
Module **dummy** is a simple module intended as a template for creating new modules.

==== Header file ====
<code cpp 1>
#ifndef DUMMYMODULE_H_
#define DUMMYMODULE_H_

#include "yuri/io/BasicIOThread.h"

namespace yuri {
namespace dummy_module {
using yuri::log::Log;
using yuri::config::Parameter;
using yuri::config::Parameters;
using yuri::io::pThreadBase;

class DummyModule: public yuri::io::BasicIOThread
{
public:
	IO_THREAD_GENERATOR_DECLARATION
	static shared_ptr<Parameters> configure();
	virtual ~DummyModule();
private:
	DummyModule(Log &log_,pThreadBase parent,Parameters &parameters);
	virtual bool step();
	virtual bool set_param(Parameter& param);
	std::string dummy_name;
};

} /* namespace dummy_module */
} /* namespace yuri */
#endif /* DUMMYMODULE_H_ */
</code>


<code cpp 4|h Include header for basic IO class>
#include "yuri/io/BasicIOThread.h"
</code>

<code cpp 13|h Publicly derive from yuri::io::BasicIOThread>
class DummyModule: public yuri::io::BasicIOThread
</code>


<code cpp 16|h Use macro to declare a generator>
IO_THREAD_GENERATOR_DECLARATION
</code>

<code cpp 17|h Declare configure method to provide default configuration>
static shared_ptr<Parameters> configure();
</code>

<code cpp 20|h Constructor should have these 3 parameters (otherwise generator won't be able to generate objects of this type. It can be private to force generation using generate()>
DummyModule(Log &log_,pThreadBase parent,Parameters &parameters);
</code>

<code cpp 21|h Declare step() method - mthod invoked to process incoming frames>
virtual bool step();
</code>

<code cpp 23|h Optionally declare method set_param() for setting parameters>
virtual bool set_param(Parameter& param);
</code>