te::plugin::CppPluginEngine Class Reference

An abstract class for plugin engines. More...

#include <CppPluginEngine.h>

Inheritance diagram for te::plugin::CppPluginEngine:

Public Member Functions
	CppPluginEngine ()
AbstractPlugin *	load (const PluginInfo &pInfo)
	It try to create and load the informed plugin. More...
void	unload (AbstractPlugin *plugin)
	It try to unload the informed plugin. More...
	~CppPluginEngine ()
	Destructor. More...

Static Public Member Functions
static std::string	getPluginFileName (const std::string &libName)
	This method will help to form the library name wich contains the plugin. More...

Detailed Description

An abstract class for plugin engines.

A plugin engine for plugins written in C++.

For each kind of programming language there will be an specific engine capable of loading and preparing the plugin before the startup method is called.

,

See also

Plugin, PluginInfo, PluginEngineFactory, CppPluginEngine

Plugin, PluginInfo, PluginEngineFactory, PluginEngine

Definition at line 50 of file CppPluginEngine.h.

Constructor & Destructor Documentation

te::plugin::CppPluginEngine::CppPluginEngine

(

)

Default construtor.

Definition at line 48 of file CppPluginEngine.cpp.

te::plugin::CppPluginEngine::~CppPluginEngine ( )

inline

Destructor.

Definition at line 58 of file CppPluginEngine.h.

Member Function Documentation

std::string te::plugin::CppPluginEngine::getPluginFileName ( const std::string &  libName )

static

This method will help to form the library name wich contains the plugin.

This method may append a prefix and suffix that are platform dependent and also the build mode: DEBUG or RELEASE.

Definition at line 224 of file CppPluginEngine.cpp.

References te::common::Library::getNativeName().

te::plugin::AbstractPlugin * te::plugin::CppPluginEngine::load ( const PluginInfo &  pInfo )

virtual

It try to create and load the informed plugin.

Parameters

pInfo

The information needed to create and load the plugin.

Returns

It returns a loaded plugin. The caller will take the ownership of the returned plugin.

Exceptions

Exception

It throws an exception if the plugin can not be loaded.

Note

If the parameter PluginInfo::m_folder does not contains the required plugin it may be searched and loaded using a set of default paths.

Implements te::plugin::AbstractPluginEngine.

Definition at line 52 of file CppPluginEngine.cpp.

References te::common::LibraryManager::add(), te::common::Singleton< LibraryManager >::getInstance(), te::plugin::PluginInfo::m_name, te::plugin::PluginInfo::m_resources, and TE_TR.

void te::plugin::CppPluginEngine::unload ( AbstractPlugin *  plugin )

virtual

It try to unload the informed plugin.

On success the informed plugin will be also destroyed and its pointer will be invalidated.

Parameters

plugin

The plugin to be unloaded.

Exceptions

Exception

It throws an exception if the plugin can not be unloaded.

Implements te::plugin::AbstractPluginEngine.

Definition at line 217 of file CppPluginEngine.cpp.

References te::plugin::AbstractPlugin::getInfo(), and te::plugin::PluginInfo::m_engine.

---

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

• C:/BB_TL5/terralib5/src/terralib/plugin/CppPluginEngine.h
• C:/BB_TL5/terralib5/src/terralib/plugin/CppPluginEngine.cpp