Spm::Plugin::InstallerInterface Class Reference

The base class for an Installer. More...

#include <installerInterface.h>

Inheritance diagram for Spm::Plugin::InstallerInterface:

List of all members.

Public Member Functions
	~InstallerInterface ()
virtual void	init (const std::map< std::string, std::string > &pOptions)
	Initialize the installation. Override this function to init your installation.
virtual void	postInstall (const std::map< std::string, std::string > &pOptions)
	Cleaning function. Override this funtion to finalize your installation.
virtual void	install (const std::map< std::string, std::string > &pOptions)
	Start the installation.
virtual const StepInterface *	getActualStep ()
virtual const std::list< boost::filesystem::path >	getInstalledElement ()=0
virtual std::map< std::string, std::string >	getUsedOptions ()=0
virtual bool	handle (Util::Compressed *compressed)=0
virtual bool	handle (const std::string &url)
const boost::filesystem::path &	getPrefix ()
virtual const std::string &	getPackageName ()
virtual const std::string &	getPackageVersion ()
virtual const std::list< std::string > &	getDependency ()
Public Attributes
boost::signal< void(Interface *)>	signalEnd )()
boost::signal< void(StepInterface *)>	signalChangedStep )()
Protected Member Functions
	InstallerInterface ()
	InstallerInterface (Util::Compressed *archive)
void	setState (state_e pluginState)
Protected Attributes
boost::filesystem::path	__prefix
boost::filesystem::path	__runningDir
Util::Compressed *	__compressed
std::string	__name
std::string	__version
std::list< std::string >	__dependency
boost::signal< void(Interface *)	__end )
boost::signal< void(StepInterface *)	__changedStep )
boost::signal< void(InstallerInterface *)	__begin )
std::list< StepInterface * >	__steps
std::list< StepInterface * >::iterator	__itStep

---

Detailed Description

The base class for an Installer.

---

Constructor & Destructor Documentation

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

Spm::Plugin::InstallerInterface::InstallerInterface (  Util::Compressed *  archive  )  [inline, protected]

Spm::Plugin::InstallerInterface::~InstallerInterface (   )  [inline]

---

Member Function Documentation

virtual const StepInterface* Spm::Plugin::InstallerInterface::getActualStep (   )  [inline, virtual]

Returns: The actual executed Step

virtual const std::list<std::string>& Spm::Plugin::InstallerInterface::getDependency (   )  [inline, virtual]

Returns: The dependencys of the installed Package

virtual const std::list<boost::filesystem::path> Spm::Plugin::InstallerInterface::getInstalledElement (   )  [pure virtual]

Returns: The list of installed files

virtual const std::string& Spm::Plugin::InstallerInterface::getPackageName (   )  [inline, virtual]

Returns: The name of the installed Package

virtual const std::string& Spm::Plugin::InstallerInterface::getPackageVersion (   )  [inline, virtual]

Returns: The version of the installed Package

const boost::filesystem::path& Spm::Plugin::InstallerInterface::getPrefix (   )  [inline]

Returns: The prefix where the Package was installed

virtual std::map<std::string, std::string> Spm::Plugin::InstallerInterface::getUsedOptions (   )  [pure virtual]

Returns: The options used by this Installer

virtual bool Spm::Plugin::InstallerInterface::handle (  const std::string &  url  )  [inline, virtual]

Parameters: url  The URL of the remote archive to install Returns: true if the Plugin is able to install this archive Implements Spm::Plugin::Interface.

virtual bool Spm::Plugin::InstallerInterface::handle (  Util::Compressed *  compressed  )  [pure virtual]

Parameters: compressed  The archive to install Returns: true if the Plugin is able to install this archive

virtual void Spm::Plugin::InstallerInterface::init (  const std::map< std::string, std::string > &  pOptions  )  [inline, virtual]

Initialize the installation. Override this function to init your installation.

virtual void Spm::Plugin::InstallerInterface::install (  const std::map< std::string, std::string > &  pOptions  )  [inline, virtual]

Start the installation. Parameters: pOptions  The options of the installation

virtual void Spm::Plugin::InstallerInterface::postInstall (  const std::map< std::string, std::string > &  pOptions  )  [inline, virtual]

Cleaning function. Override this funtion to finalize your installation.

void Spm::Plugin::InstallerInterface::setState (  state_e  pluginState  )  [inline, protected]

---

Member Data Documentation

boost::signal<void (InstallerInterface *) Spm::Plugin::InstallerInterface::__begin) [protected]

boost::signal<void (StepInterface *) Spm::Plugin::InstallerInterface::__changedStep) [protected]

Util::Compressed* Spm::Plugin::InstallerInterface::__compressed [protected]

std::list<std::string> Spm::Plugin::InstallerInterface::__dependency [protected]

boost::signal<void (Interface *) Spm::Plugin::InstallerInterface::__end) [protected]

std::list<StepInterface *>::iterator Spm::Plugin::InstallerInterface::__itStep [protected]

std::string Spm::Plugin::InstallerInterface::__name [protected]

boost::filesystem::path Spm::Plugin::InstallerInterface::__prefix [protected]

boost::filesystem::path Spm::Plugin::InstallerInterface::__runningDir [protected]

std::list<StepInterface *> Spm::Plugin::InstallerInterface::__steps [protected]

std::string Spm::Plugin::InstallerInterface::__version [protected]

boost::signal<void (StepInterface *)> Spm::Plugin::InstallerInterface::signalChangedStep)() [inline]

boost::signal<void (Interface *)> Spm::Plugin::InstallerInterface::signalEnd)() [inline]

---

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

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

---