Spm::Plugin::StepInterface Class Reference

The base class for step plugin. More...

#include <stepInterface.h>

Inheritance diagram for Spm::Plugin::StepInterface:

List of all members.

Public Member Functions
virtual	~StepInterface ()
virtual void	run (const boost::filesystem::path &dir)=0
	perform an action
const miniXml::ustring &	getStepDescription ()
const miniXml::ustring &	getStepDescription () const
virtual double	getFractionDone ()
	return the percent of completed work
virtual double	getFractionDone () const
	return the percent of completed work
bool	handle (const miniXml::ustring &uri)
	Not needed for Stepinterface.
const std::map< miniXml::ustring, miniXml::ustring > &	getOptions ()
virtual std::list< boost::filesystem::path >	getListOfFiles ()=0
Protected Member Functions
	StepInterface (const Util::PropertyList &pList)
	StepInterface ()
Protected Attributes
miniXml::ustring	stepDescription_
double	fractionDone_
std::map< miniXml::ustring, miniXml::ustring >	__usedOptions

---

Detailed Description

The base class for step plugin.

---

Constructor & Destructor Documentation

Spm::Plugin::StepInterface::StepInterface

(

const Util::PropertyList &

pList

)

[inline, protected]

Spm::Plugin::StepInterface::StepInterface

(

)

[inline, protected]

virtual Spm::Plugin::StepInterface::~StepInterface

(

)

[inline, virtual]

---

Member Function Documentation

virtual void Spm::Plugin::StepInterface::run

(

const boost::filesystem::path &

dir

)

[pure virtual]

perform an action

Returns:

true if step was succesfully completed

const miniXml::ustring& Spm::Plugin::StepInterface::getStepDescription

(

)

[inline]

Returns:

A short text description of the Step.

const miniXml::ustring& Spm::Plugin::StepInterface::getStepDescription

(

)

const [inline]

Returns:

A short text description of the Step.

virtual double Spm::Plugin::StepInterface::getFractionDone

(

)

[inline, virtual]

return the percent of completed work

virtual double Spm::Plugin::StepInterface::getFractionDone

(

)

const [inline, virtual]

return the percent of completed work

bool Spm::Plugin::StepInterface::handle

(

const miniXml::ustring &

uri

)

[inline]

Not needed for Stepinterface.

Returns:

Always true

const std::map<miniXml::ustring, miniXml::ustring>& Spm::Plugin::StepInterface::getOptions

(

)

[inline]

Returns:

Options used by this Step

virtual std::list<boost::filesystem::path> Spm::Plugin::StepInterface::getListOfFiles

(

)

[pure virtual]

Returns:

The list of files installed by the Step

---

Member Data Documentation

miniXml::ustring Spm::Plugin::StepInterface::stepDescription_ [protected]

double Spm::Plugin::StepInterface::fractionDone_ [protected]

std::map<miniXml::ustring, miniXml::ustring> Spm::Plugin::StepInterface::__usedOptions [protected]

---

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

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

---