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 std::string &	getStepDescription ()
const std::string &	getStepDescription () const
virtual double	getFractionDone ()
	return the percent of completed work
virtual double	getFractionDone () const
	return the percent of completed work
bool	handle (const std::string &uri)
	Not needed for Stepinterface.
const std::map< std::string, std::string > &	getOptions ()
virtual std::list< boost::filesystem::path >	getListOfFiles ()=0
Protected Member Functions
	StepInterface (const std::map< std::string, std::string > &pOptions)
	StepInterface ()
Protected Attributes
std::string	__stepDescription
double	__fractionDone
std::map< std::string, std::string >	__usedOptions

---

Detailed Description

The base class for step plugin.

---

Constructor & Destructor Documentation

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

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

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

---

Member Function Documentation

virtual double Spm::Plugin::StepInterface::getFractionDone (   )  const [inline, virtual]

return the percent of completed work

virtual double Spm::Plugin::StepInterface::getFractionDone (   )  [inline, virtual]

return the percent of completed work

virtual std::list<boost::filesystem::path> Spm::Plugin::StepInterface::getListOfFiles (   )  [pure virtual]

Returns: The list of files installed by the Step

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

Returns: Options used by this Step

const std::string& Spm::Plugin::StepInterface::getStepDescription (   )  const [inline]

Returns: A short text description of the Step.

const std::string& Spm::Plugin::StepInterface::getStepDescription (   )  [inline]

Returns: A short text description of the Step.

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

Not needed for Stepinterface. Returns: Always true Implements Spm::Plugin::Interface.

virtual void Spm::Plugin::StepInterface::run (  const boost::filesystem::path &  dir  )  [pure virtual]

perform an action Returns: true if step was succesfully completed

---

Member Data Documentation

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

std::string Spm::Plugin::StepInterface::__stepDescription [protected]

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

---

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

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

---