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 ()
	Initialize the installation. Override this function to init your installation.
virtual void	postInstall ()
	Cleaning function. Override this funtion to finalize your installation.
virtual void	install ()
	Start the installation.
virtual const StepInterface *	getActualStep ()
virtual const std::list< boost::filesystem::path >	getInstalledElement ()=0
virtual std::map< miniXml::ustring, miniXml::ustring >	getUsedOptions ()=0
virtual std::map< miniXml::ustring, boost::tuple< miniXml::ustring, int, Util::PropertyList::propertyType_e > >	getOptions ()=0
const boost::filesystem::path &	getPrefix ()
virtual const miniXml::ustring &	getPackageName ()
virtual const miniXml::ustring &	getPackageVersion ()
virtual const std::list< miniXml::ustring > &	getDependency ()
Util::PropertyList &	installOptions ()
virtual void	installOptions (const Util::PropertyList &pList)
	Set install options of an installer.
Public Attributes
boost::signal< void(StepInterface *)>	signalChangedStep )()
boost::signal< void(InstallerInterface *)>	signalMetaDataParsed )()
boost::signal< void(InstallerInterface *)>	signalHaveOptions )()
Protected Member Functions
	InstallerInterface ()
	InstallerInterface (Util::Compressed *archive, const Util::PropertyList &pList=Util::PropertyList())
void	setState (state_e pluginState)
Protected Attributes
boost::filesystem::path	prefix_
boost::filesystem::path	runningDir_
Util::Compressed *	compressed_
miniXml::ustring	name_
miniXml::ustring	version_
std::list< miniXml::ustring >	dependency_
boost::signal< void(StepInterface *)>	changedStep_
boost::signal< void(InstallerInterface *)>	metaDataParsed_
boost::signal< void(InstallerInterface *)>	haveOptions_
boost::recursive_mutex	mutex_
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,
		const Util::PropertyList &	pList = Util::PropertyList()
	)			[inline, protected]

Spm::Plugin::InstallerInterface::~InstallerInterface

(

)

[inline]

---

Member Function Documentation

void Spm::Plugin::InstallerInterface::setState

(

state_e

pluginState

)

[inline, protected]

virtual void Spm::Plugin::InstallerInterface::init

(

)

[inline, virtual]

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

virtual void Spm::Plugin::InstallerInterface::postInstall

(

)

[inline, virtual]

Cleaning function. Override this funtion to finalize your installation.

virtual void Spm::Plugin::InstallerInterface::install

(

)

[inline, virtual]

Start the installation.

virtual const StepInterface* Spm::Plugin::InstallerInterface::getActualStep

(

)

[inline, virtual]

Returns:

The actual executed Step

virtual const std::list<boost::filesystem::path> Spm::Plugin::InstallerInterface::getInstalledElement

(

)

[pure virtual]

Returns:

The list of installed files

virtual std::map<miniXml::ustring, miniXml::ustring> Spm::Plugin::InstallerInterface::getUsedOptions

(

)

[pure virtual]

Returns:

The options used by this Installer

virtual std::map<miniXml::ustring, boost::tuple<miniXml::ustring, int, Util::PropertyList::propertyType_e> > Spm::Plugin::InstallerInterface::getOptions

(

)

[pure virtual]

const boost::filesystem::path& Spm::Plugin::InstallerInterface::getPrefix

(

)

[inline]

Returns:

The prefix where the Package was installed

virtual const miniXml::ustring& Spm::Plugin::InstallerInterface::getPackageName

(

)

[inline, virtual]

Returns:

The name of the installed Package

virtual const miniXml::ustring& Spm::Plugin::InstallerInterface::getPackageVersion

(

)

[inline, virtual]

Returns:

The version of the installed Package

virtual const std::list<miniXml::ustring>& Spm::Plugin::InstallerInterface::getDependency

(

)

[inline, virtual]

Returns:

The dependencys of the installed Package

Util::PropertyList& Spm::Plugin::InstallerInterface::installOptions

(

)

[inline]

Returns:

The options used by this installer

virtual void Spm::Plugin::InstallerInterface::installOptions

(

const Util::PropertyList &

pList

)

[inline, virtual]

Set install options of an installer.

Parameters:

pList

The options of the installer

---

Member Data Documentation

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

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

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

miniXml::ustring Spm::Plugin::InstallerInterface::name_ [protected]

miniXml::ustring Spm::Plugin::InstallerInterface::version_ [protected]

std::list<miniXml::ustring> Spm::Plugin::InstallerInterface::dependency_ [protected]

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

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

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

boost::recursive_mutex Spm::Plugin::InstallerInterface::mutex_ [protected]

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

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

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

Returns:

The signal emitted when the current step of an installer changed

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

Returns:

The signal emitted when the installer has parsed all meta-data of a Package to install

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

Returns:

The signal emitted when the installer have his options

---

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

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

---