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 Member Functions
	Interface (const std::map< std::string, std::string > &pOptions)
virtual	~Interface ()
virtual bool	handle (const std::string &uri)=0
const pluginDescription_t &	getDescription ()
state_e	getState ()
state_e	getState () const
Protected Member Functions
	Interface ()
Protected Attributes
pluginDescription_t	__description
std::map< std::string, std::string >	pluginOptions
state_e	currentState
Friends
class	Plugin

---

Detailed Description

The base class for all plugins.

---

Constructor & Destructor Documentation

Spm::Plugin::Interface::Interface (   )  [inline, protected]

Spm::Plugin::Interface::Interface (  const std::map< std::string, std::string > &  pOptions  )  [inline]

virtual Spm::Plugin::Interface::~Interface (   )  [inline, virtual]

---

Member Function Documentation

const pluginDescription_t& Spm::Plugin::Interface::getDescription (   )  [inline]

state_e Spm::Plugin::Interface::getState (   )  const [inline]

Returns: The current state of the plugin

state_e Spm::Plugin::Interface::getState (   )  [inline]

Returns: The current state of the plugin

virtual bool Spm::Plugin::Interface::handle (  const std::string &  uri  )  [pure virtual]

Implemented in Spm::Plugin::DownloadInterface, Spm::Plugin::InstallerInterface, and Spm::Plugin::StepInterface.

---

Friends And Related Function Documentation

friend class Plugin [friend]

---

Member Data Documentation

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

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

std::map<std::string, std::string> Spm::Plugin::Interface::pluginOptions [protected]

---

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

• /tmp/spmTest/spm-HEAD/src/include/plugin/interface.h

---