AbstractModule Class Reference
[Processing modules]

Module interface. More...

#include <AbstractModule.h>

Inheritance diagram for AbstractModule:

[legend]

Collaboration diagram for AbstractModule:

[legend]

List of all members.

Public Member Functions
	AbstractModule ()
	Constructor.
virtual	~AbstractModule ()
	Destructor - deletes GUI if there is one.
virtual void	processFrameData (IFrameData *data)=0
void	assertFramedataType (IFrameData *data, std::string type, std::string where) throw (WarningWrongFrameDataType)
	Helper function.
Protected Member Functions
void	deleteGUI ()
	Cleans up the memory.
void	setGUI (AbstractModuleGUI *gui)
AbstractModuleGUI *	getGUI () const

---

Detailed Description

Module interface.

General interface for modules as described in the decorator pattern

Definition at line 19 of file AbstractModule.h.

---

Constructor & Destructor Documentation

AbstractModule::AbstractModule

(

)

[inline]

Constructor.

Definition at line 23 of file AbstractModule.h.

virtual AbstractModule::~AbstractModule

(

)

[inline, virtual]

Destructor - deletes GUI if there is one.

Definition at line 26 of file AbstractModule.h.

---

Member Function Documentation

void AbstractModule::assertFramedataType	(	IFrameData *	data,
		std::string	type,
		std::string	where
	)			throw (WarningWrongFrameDataType)

Helper function.

Throws a Warning if incoming data is not of expected type

Parameters:

	data	Incoming data
	type	Expected type
	where	Additional information of where this happened

Definition at line 18 of file AbstractModule.cpp.

void AbstractModule::deleteGUI

(

)

[protected]

Cleans up the memory.

Definition at line 4 of file AbstractModule.cpp.

AbstractModuleGUI* AbstractModule::getGUI

(

)

const [inline, protected]

Returns:

The GUI if there is one

Definition at line 57 of file AbstractModule.h.

virtual void AbstractModule::processFrameData

(

IFrameData *

data

)

[pure virtual]

The modules work is done here

Parameters:

data

Incoming data for the module

Implemented in DirectionFilter, GestureFinder, HMMModule, OutputModule, ProcessModule, and Smoother.

void AbstractModule::setGUI

(

AbstractModuleGUI *

gui

)

[protected]

Set GUI of this module. May only be called by module itself

Parameters:

gui

The GUI

Definition at line 12 of file AbstractModule.cpp.

---

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

• modules/AbstractModule.h
• modules/AbstractModule.cpp