tlp::IntegerAlgorithm Class Reference

Interface for int plug-ins. More...

#include <IntegerAlgorithm.h>

Inheritance diagram for tlp::IntegerAlgorithm:

Collaboration diagram for tlp::IntegerAlgorithm:

Public Member Functions
virtual	~IntegerAlgorithm ()
Public Member Functions inherited from tlp::Algorithm
	Algorithm (const AlgorithmContext &context)
	Constructs an algorithm and initializes members from the AlgorithmContext.
virtual	~Algorithm ()
virtual bool	run ()
	Runs the algorithm on the context that was specified during construction.
virtual bool	check (std::string &)
	Checks if the algorithm can run on the context it was given.
Public Member Functions inherited from tlp::WithParameter
const tlp::ParameterDescriptionList &	getParameters ()
	Retrieves the parameters.
template<typename T >
void	addInParameter (const char *str, const char *inHelp=0, const char *inDefValue=0, bool isMandatory=true)
	Adds an IN parameter to the plug-in.
template<typename T >
void	addOutParameter (const char *str, const char *inHelp=0, const char *inDefValue=0, bool isMandatory=true)
	Adds an OUT parameter to the plug-in.
template<typename T >
void	addInOutParameter (const char *str, const char *inHelp=0, const char *inDefValue=0, bool isMandatory=true)
	Adds an INOUT parameter to the plug-in.
template<typename T >
void	addParameter (const char *parameterName, const char *help=NULL, const char *defaultValue=NULL, bool isMandatory=true)
	Adds an IN parameter to the plug-in (deprecated)
Public Member Functions inherited from tlp::WithDependency
std::list< Dependency >	getDependencies ()
	Gets the list of Dependencies of this plug-in.
template<typename Ty >
void	addDependency (const char *name, const char *release)
	Adds a dependency upon another plug-in. The parameters should be null-terminated strings, or NULL.

Public Attributes
IntegerProperty *	integerResult
Public Attributes inherited from tlp::Algorithm
Graph *	graph
	The graph this algorithm will be run on. Retrieved from the context at construction.
PluginProgress *	pluginProgress
	A PluginProgress to give feedback to the user, retrieved from the context. It can be a NULL pointer, so use with caution.
DataSet *	dataSet
	A DataSet containing parameters for this algorithm, if any. Retrieved from the context at construction.

Protected Member Functions
	IntegerAlgorithm (const AlgorithmContext &context)

Friends
class	IntegerProperty

Additional Inherited Members
Protected Attributes inherited from tlp::WithParameter
ParameterDescriptionList	parameters
	The internal structure storing the parameters.
Protected Attributes inherited from tlp::WithDependency
std::list< Dependency >	dependencies
	The inner list of dependencies.

Detailed Description

Interface for int plug-ins.

Constructor & Destructor Documentation

virtual tlp::IntegerAlgorithm::~IntegerAlgorithm ( )

inlinevirtual

tlp::IntegerAlgorithm::IntegerAlgorithm ( const AlgorithmContext &  context )

protected

Friends And Related Function Documentation

friend class IntegerProperty

friend

Member Data Documentation

IntegerProperty* tlp::IntegerAlgorithm::integerResult

This int obj is the one associated to the algorithm, The data should be store in it