RDK2::RAgent::Module Class Reference

#include <module.h>

Collaboration diagram for RDK2::RAgent::Module:

Detailed Description

This is the base class of each RDK module.

Definition at line 79 of file module.h.


Public Member Functions
	Module ()
virtual bool	initConfigurationProperties ()
virtual bool	initInterfaceProperties ()
virtual bool	init ()
void	start ()
	Instantiates module thread that will call exec().
virtual void	exec ()=0
	ASSUMPTION: all modules init()-ed succesfully.
virtual void	asyncAgentCmd (cstr)
virtual void	exitRequested ()
virtual void	cleanup ()
void	requestExit ()
virtual	~Module ()
string	getModuleName ()
void	setSession (Session *session)
void	setQtSession (Session *qtSession)
void	setAsyncSession (Session *asyncSession)
void	initWithModuleConfig (const ModuleConfig &cm, bool configureOnlyPendingProperties=false)
ModuleConfig	createModuleConfig ()
Static Public Member Functions
static Module *	createFromLibrary (cstr libraryName)
Data Fields
ModuleConfig	oldConfig
Protected Member Functions
ModuleManager *	getModuleManager ()
void	setModuleManager (ModuleManager *mm)
Protected Attributes
volatile bool	exiting
Session *	session
Session *	qtSession
Session *	asyncSession
set< string >	pendingConfigurableProperties
string	moduleName
string	library
ModuleManager *	moduleManager
Friends
class	ModuleManager

Constructor & Destructor Documentation

RDK2::RAgent::Module::Module ( ) [inline]

Definition at line 82 of file module.h.

RDK2::RAgent::Module::~Module ( ) [virtual]

Definition at line 55 of file module.cpp.

Member Function Documentation

virtual bool RDK2::RAgent::Module::initConfigurationProperties ( ) [inline, virtual]

Declare configuration properties.

This method should have a very short execution time.

ASSUMPTIONS: this module can't make any assumption.

Definition at line 93 of file module.h.

virtual bool RDK2::RAgent::Module::initInterfaceProperties ( ) [inline, virtual]

Declare properties and queues that interface to other modules.

ASSUMPTIONS: configuration was loaded, but no assumption can be made about other modules.

FIXME DC: le properties di interfaccia non vengono salvate? (anzi, non vengono caricate, in questo caso)

Definition at line 104 of file module.h.

Referenced by RDK2::RAgent::ModuleManager::instantiateAdditionalModule().

virtual bool RDK2::RAgent::Module::init ( ) [inline, virtual]

Inizializzazione risorse (apri file, socket, ecc) ASSUNZIONI: gli altri moduli sono stati caricati e le loro proprietà create. I moduli elencati prima di te hanno fatto init() con successo. Initialize resources (open files, sockets, etc.)

ASSUMPTIONS: other modules are loaded and their properties are created. Modules listed before this have succesfully init()-ed.

Definition at line 117 of file module.h.

Referenced by RDK2::RAgent::ModuleManager::instantiateAdditionalModule().

void RDK2::RAgent::Module::start ( )

Instantiates module thread that will call exec().

Referenced by RDK2::RAgent::ModuleManager::instantiateAdditionalModule().

virtual void RDK2::RAgent::Module::exec ( ) [pure virtual]

ASSUMPTION: all modules init()-ed succesfully.

virtual void RDK2::RAgent::Module::asyncAgentCmd ( cstr ) [inline, virtual]

This method should follow what's written in the wiki page http://sied.dis.uniroma1.it/private/doku.php?id=rdk:robot_modules

Definition at line 129 of file module.h.

virtual void RDK2::RAgent::Module::exitRequested ( ) [inline, virtual]

when this function exits, the module manager can safely call pthread_join the user should implement this only if the module has something to be closed before the thread is joined (e.g.: close sockets)

Definition at line 134 of file module.h.

virtual void RDK2::RAgent::Module::cleanup ( ) [inline, virtual]

Definition at line 136 of file module.h.

void RDK2::RAgent::Module::requestExit ( )