Spm::Plugin::Interface Class Reference

The base class for all plugins. More...

#include <interface.h>

Inheritance diagram for Spm::Plugin::Interface:

List of all members.

Public Types
enum	state_e { INITIALIZATION, RUNNING, ENDED, FAILED }
Public Member Functions
virtual	~Interface ()
const pluginDescription_t &	getDescription ()
state_e	getState ()
state_e	getState () const
Protected Member Functions
	Interface ()
	Interface (const Util::PropertyList &pList)
virtual void	initInfo ()=0
Protected Attributes
pluginDescription_t	description_
Util::PropertyList	options_
state_e	currentState_
Friends
class	Plugin

---

Detailed Description

The base class for all plugins.

---

Member Enumeration Documentation

enum Spm::Plugin::Interface::state_e

Enumerator:

INITIALIZATION
RUNNING
ENDED
FAILED

---

Constructor & Destructor Documentation

Spm::Plugin::Interface::Interface

(

)

[inline, protected]

Spm::Plugin::Interface::Interface

(

const Util::PropertyList &

pList

)

[inline, protected]

virtual Spm::Plugin::Interface::~Interface

(

)

[inline, virtual]

---

Member Function Documentation

virtual void Spm::Plugin::Interface::initInfo

(

)

[protected, pure virtual]

const pluginDescription_t& Spm::Plugin::Interface::getDescription

(

)

[inline]

Returns:

The Description of the Plugin

state_e Spm::Plugin::Interface::getState

(

)

[inline]

Returns:

The current state of the plugin

state_e Spm::Plugin::Interface::getState

(

)

const [inline]

Returns:

The current state of the plugin

---

Friends And Related Function Documentation

friend class Plugin [friend]

---

Member Data Documentation

pluginDescription_t Spm::Plugin::Interface::description_ [protected]

Util::PropertyList Spm::Plugin::Interface::options_ [protected]

state_e Spm::Plugin::Interface::currentState_ [protected]

---

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

• /home/elche/Prog/Projects/spm-0.8/src/include/plugin/interface.h

---