tlp::ImportModule Class Reference

Base class for import plug-ins. More...

#include <ImportModule.h>

Inheritance diagram for tlp::ImportModule:

Collaboration diagram for tlp::ImportModule:

Public Member Functions
	ImportModule (AlgorithmContext context)
	Initializes the DataSet to the one passed in the context.
virtual	~ImportModule ()
virtual bool	importGraph ()
	The import operations should take place here.
virtual _DEPRECATED bool	import (const std::string &)
	deprecated method.
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
Graph *	graph
	The Graph in which to write the data to import.
PluginProgress *	pluginProgress
	A means to report progress to the user.
DataSet *	dataSet
	A container for the parameters of this import plug-in.

Additional Inherited Members
Protected Member Functions inherited from tlp::WithDependency
void	addDependency (const char *factory, const char *name, const char *release)
	Adds a dependency upon another plug-in.
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

Base class for import plug-ins.

Constructor & Destructor Documentation

tlp::ImportModule::ImportModule ( AlgorithmContext  context )

inline

Initializes the DataSet to the one passed in the context.

Parameters

context

THe context this import plug-in runs into.

virtual tlp::ImportModule::~ImportModule ( )

inlinevirtual

Member Function Documentation

virtual _DEPRECATED bool tlp::ImportModule::import ( const std::string &  )

inlinevirtual

deprecated method.

Parameters

unused,deprecated

parameter

Returns

bool Whether the import was successful or not.

virtual bool tlp::ImportModule::importGraph ( )

virtual

The import operations should take place here.

Returns

bool Whether the import was successful or not.

Member Data Documentation

DataSet* tlp::ImportModule::dataSet

A container for the parameters of this import plug-in.

Graph* tlp::ImportModule::graph

The Graph in which to write the data to import.

PluginProgress* tlp::ImportModule::pluginProgress

A means to report progress to the user.