te::plugin Namespace Reference

Namespace for the Plugin module of TerraLib. More...

Classes
class	AbstractFinder
	The AbstractFinder class allows applications to extend how PluginManager can search for plugins. More...
class	AbstractPlugin
	An abstract class for TerraLib Plugins. More...
class	AbstractPluginEngine
class	CppPlugin
	An abstract interface for Plugins written in C++. More...
class	CppPluginEngine
	An abstract class for plugin engines. More...
class	CppPluginEngineFactory
	This is the concrete factory for C++ plugin engines. More...
class	CppPluginProxy
	A proxy class for C++ plugins. More...
class	DefaultFinder
	A plugin finder that search for plugins in some special directories defined by compile time macros. More...
class	Module
	This singleton defines the TerraLib Plugin module entry. More...
class	Plugin
	A base class for plugin types. More...
class	PluginEngineFactory
	This is the abstract factory for plugin engines. More...
struct	PluginInfo
	The basic information about a plugin. More...
class	PluginManager
	A singleton for managing plugins. More...
struct	Provider
	This struct can be used to describe a given plugin provider. More...

Typedefs
typedef Plugin *(*	GetPluginFPtr) (const PluginInfo &info)
	It exports Plugin's access function type. More...

Functions
TEPLUGINEXPORT PluginInfo *	GetInstalledPlugin (const std::string &pluginFilePath)
	It returns information about a given plugin provided its plugin configuration file name or dir. More...
TEPLUGINEXPORT void	Unload (const std::string &plugin)
	It recursively unload the plugin and any dependent plugins. More...
TEPLUGINEXPORT void	UnloadAllPluginsFromEngine (const std::string &engine)
	It unloads all plugins from a given engine. More...

Detailed Description

Namespace for the Plugin module of TerraLib.

Typedef Documentation

Plugin *(* te::plugin::GetPluginFPtr)(const PluginInfo &info)

It exports Plugin's access function type.

When you are building a C++ Plugin, you will have to define a special function (that has a special name convention) to be called by TerraLib in order to load your plugin. Please, see the documentation HowTo Create C++ TerraLib Plugins for more information.

Definition at line 92 of file Plugin.h.

Function Documentation

TEPLUGINEXPORT PluginInfo* te::plugin::GetInstalledPlugin

(

const std::string &

pluginFilePath

)

It returns information about a given plugin provided its plugin configuration file name or dir.

Parameters

pluginFilePath

Plugin configuration file name or dir (may be a relative path).

Returns

The information about the plugin contained in the informed configuration file or dir. The caller will take the ownership of the returned PluginInfo.

Exceptions

Exception

It throws an exception if it is not possible to retrieve information about the plugin.

TEPLUGINEXPORT void te::plugin::Unload

(

const std::string &

plugin

)

It recursively unload the plugin and any dependent plugins.

TEPLUGINEXPORT void te::plugin::UnloadAllPluginsFromEngine

(

const std::string &

engine

)

It unloads all plugins from a given engine.

Note

This method may propagate the unload of dependent plugins.