Spm::Plugin::Plugin Class Reference

#include <plugin.h>

Inheritance diagram for Spm::Plugin::Plugin:

List of all members.

Public Member Functions
	Plugin ()
	Plugin (const boost::filesystem::path &aFile)
	~Plugin ()
const std::string &	getDescription ()
const boost::filesystem::path &	getPath ()
pluginType_e	getType ()
const std::string &	getDescription () const
const boost::filesystem::path &	getPath () const
pluginType_e	getType () const
const std::string &	getVersion ()
const std::string &	getVersion () const
const std::string &	getAuthor ()
const std::string &	getAuthor () const
const license_e &	getLicense ()
const license_e &	getLicense () const
Interface *	getObject (const std::map< std::string, std::string > &pOptions) throw (NotActivePluginException, PluginException)
Interface *	getObject () throw (NotActivePluginException, PluginException)
DownloadInterface *	getDownloaderObject (const Util::urlDetails &url) throw (NotActivePluginException, PluginException)
InstallerInterface *	getObject (Util::Compressed *compressed) throw (NotActivePluginException, PluginException)
bool	isEnable ()
bool	isEnable () const
const std::map< std::string, std::string > &	getPluginOptions ()
const std::map< std::string, std::string > &	getPluginOptions () const
void	enable ()
	Enable the plugin.
void	disable ()
	disable the plugin
bool	operator< (const Plugin &p) const
Static Public Member Functions
static Plugin *	isAPlugin (const boost::filesystem::path &aFile) throw (NotAPluginException)
	Check if a file is a Plugin.
Friends
class	PluginSystem
Plugin *	convertXmlToPlugin (const miniXml::Element *pluginElement)

---

Constructor & Destructor Documentation

Spm::Plugin::Plugin::Plugin (   )

Spm::Plugin::Plugin::Plugin (  const boost::filesystem::path &  aFile  )

Parameters: aFile  The file plugin file's

Spm::Plugin::Plugin::~Plugin (   )

---

Member Function Documentation

void Spm::Plugin::Plugin::disable (   )

disable the plugin

void Spm::Plugin::Plugin::enable (   )

Enable the plugin.

const std::string& Spm::Plugin::Plugin::getAuthor (   )  const

Returns: The author of the Plugin

const std::string& Spm::Plugin::Plugin::getAuthor (   )

Returns: The author of the Plugin

const std::string& Spm::Plugin::Plugin::getDescription (   )  const

const std::string& Spm::Plugin::Plugin::getDescription (   )

Returns: The description of the Plugin

DownloadInterface* Spm::Plugin::Plugin::getDownloaderObject (  const Util::urlDetails &  url  )  throw (NotActivePluginException, PluginException)

Parameters: url  The URL (at least service and host) of the remote file Returns: The Object

const license_e& Spm::Plugin::Plugin::getLicense (   )  const

Returns: The license of the Plugin

const license_e& Spm::Plugin::Plugin::getLicense (   )

Returns: The license of the Plugin

InstallerInterface* Spm::Plugin::Plugin::getObject (  Util::Compressed *  compressed  )  throw (NotActivePluginException, PluginException)

Parameters: compressed  A Compressed object which will be installed by the Plugin Returns: The Object

Interface* Spm::Plugin::Plugin::getObject (   )  throw (NotActivePluginException, PluginException)

Returns: The Object

Interface* Spm::Plugin::Plugin::getObject (  const std::map< std::string, std::string > &  pOptions  )  throw (NotActivePluginException, PluginException)

Parameters: pOptions  The options of the Plugin Object's Returns: The Object

const boost::filesystem::path& Spm::Plugin::Plugin::getPath (   )  const

const boost::filesystem::path& Spm::Plugin::Plugin::getPath (   )

const std::map<std::string, std::string>& Spm::Plugin::Plugin::getPluginOptions (   )  const

Returns: The options accepted by this Plugin

const std::map<std::string, std::string>& Spm::Plugin::Plugin::getPluginOptions (   )

Returns: The options accepted by this Plugin

pluginType_e Spm::Plugin::Plugin::getType (   )  const

pluginType_e Spm::Plugin::Plugin::getType (   )

Returns: The type of the Plugin

const std::string& Spm::Plugin::Plugin::getVersion (   )  const

Returns: The version of the Plugin

const std::string& Spm::Plugin::Plugin::getVersion (   )

Returns: The version of the Plugin

static Plugin* Spm::Plugin::Plugin::isAPlugin (  const boost::filesystem::path &  aFile  )  throw (NotAPluginException) [static]

Check if a file is a Plugin. Parameters: aFile  the file to check p  The Plugin to create Returns: The description of the Plugin

bool Spm::Plugin::Plugin::isEnable (   )  const

bool Spm::Plugin::Plugin::isEnable (   )

Returns: true if the plugin is enable

bool Spm::Plugin::Plugin::operator< (  const Plugin &  p  )  const

---

Friends And Related Function Documentation

Plugin* convertXmlToPlugin (  const miniXml::Element *  pluginElement  )  [friend]

friend class PluginSystem [friend]

---

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

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

---