tlp::CPPPlugin Class Reference

#include <telCPPPlugin.h>

Inheritance diagram for tlp::CPPPlugin:

Public Member Functions
	CPPPlugin (const string &name, const string &cat=gNoneString, RoadRunner *aRR=NULL, const PluginManager *pm=NULL)
virtual	~CPPPlugin ()
string	getImplementationLanguage ()
Public Member Functions inherited from tlp::Plugin
	Plugin (const string &name=gEmptyString, const string &cat=gNoneString, RoadRunner *aRR=NULL, const string &language=gNoneString, const PluginManager *pm=NULL)
virtual	~Plugin ()
string	getName ()
string	getLibraryName ()
string	getAuthor ()
string	getCategory ()
string	getDescription ()
string	getHint ()
string	getVersion ()
string	getCopyright ()
RoadRunner *	getRoadRunnerInstance ()
virtual string	getInfo ()
virtual string	getExtendedInfo ()
virtual unsigned char *	getManualAsPDF () const
virtual unsigned int	getPDFManualByteSize ()
virtual Properties *	getProperties ()
virtual tlp::StringList	getPropertyNames ()
string	getPluginPropertiesAsXML ()
virtual PropertyBase *	getProperty (const string &param)
string	getPropertyValueAsString (const string &param)
void *	getPropertyValueHandle (const string &param)
void	setPropertyByString (const string &nameOf, const char *value)
void	setPropertyValue (const string &nameOf, const void *value)
void	terminate ()
bool	isBeingTerminated () const
bool	wasTerminated () const
	check if the plugin was terminated
virtual bool	isWorking () const
	check if the plugin is working
virtual bool	assignRoadRunnerInstance (RoadRunner *rr)
	Assign a roadrunner instance for the plugin to use.
virtual bool	assignOnStartedEvent (PluginEvent pluginStarted, void *userData1=NULL, void *userData2=NULL)
virtual bool	assignOnProgressEvent (PluginEvent pluginsProgress, void *userData1=NULL, void *userData2=NULL)
virtual bool	assignOnFinishedEvent (PluginEvent pluginsFinished, void *userData1=NULL, void *userData2=NULL)
virtual string	getResult ()
virtual bool	resetPlugin ()
virtual string	getStatus ()
bool	hasStartedEvent () const
bool	hasProgressEvent () const
bool	hasFinishedEvent () const
void	WorkStartedEvent (void *data1, void *data2)
void	WorkProgressEvent (void *data1, void *data2)
void	WorkFinishedEvent (void *data1, void *data2)
pair< void *, void * >	getWorkStartedData ()
pair< void *, void * >	getWorkProgressData ()
pair< void *, void * >	getWorkFinishedData ()
virtual bool	execute (bool inAThread=false)=0
const PluginManager *	getPluginManager ()

Additional Inherited Members
Protected Member Functions inherited from tlp::Plugin
void	setLibraryName (const string &libName)
Protected Attributes inherited from tlp::Plugin
string	mName
	Name of Plugin.
string	mLibraryName
	Name of compiled shared library implementing the Plugin.
string	mAuthor
	Name of plugin author(s)
string	mCategory
	Plugin category.
string	mDescription
	Plugin description.
string	mHint
	Plugin Hint.
string	mVersion
	Plugin version.
string	mCopyright
	Plugin copyright language.
string	mImplementationLanguage
	Plugin implementation language.
bool	mTerminate
	Boolean flag indicating if a user wants to terminate the work in a plugin.
bool	mIsWorking
	Boolean flag indicating if the plugin is working.
RoadRunner *	mRR
const PluginManager *	mPM
PluginEvent	mWorkStartedEvent
PluginEvent	mWorkProgressEvent
PluginEvent	mWorkFinishedEvent
void *	mWorkStartedData1
void *	mWorkStartedData2
void *	mWorkProgressData1
void *	mWorkProgressData2
void *	mWorkFinishedData1
void *	mWorkFinishedData2
Properties	mProperties

Detailed Description

Plugins written in C++ should inherit from this class.

Constructor & Destructor Documentation

tlp::CPPPlugin::CPPPlugin	(	const string &	name,
		const string &	cat = gNoneString,
		RoadRunner *	aRR = NULL,
		const PluginManager *	pm = NULL
	)

Create a Plugin, written in C++.

tlp::CPPPlugin::~CPPPlugin ( )

virtual

Deallocate the Plugin.

Member Function Documentation

string tlp::CPPPlugin::getImplementationLanguage ( )

virtual

Retrieve the implementation language of the plugin.

Implements tlp::Plugin.

---

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

• core/telCPPPlugin.h
• core/telCPPPlugin.cpp