| TerraLib 4.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files
- Examples

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Protected Types | Protected Attributes
PluginsManager Class Reference

A class to deal with dynamic plugin loading/unloading. More...

`#include <PluginsManager.h>`

List of all members.

## Public Member Functions

| PluginsManager ()
virtual | ~PluginsManager ()
virtual void | setDefaultPluginsParameters (const PluginParameters &pp)
virtual unsigned int | loadPlugins (const std::string &path)
virtual void | unloadPlugins ()
virtual bool | runPlugin (const PluginInfo &pinfo) const
virtual void | getValidPluginsList (std::vector< PluginInfo > &plist) const
virtual void | getInvalidPluginsList (std::vector< PluginInfo > &plist) const

## Protected Types

typedef std::pair< PluginInfo, long > | SPLPluginInfoT

## Protected Attributes

void * | pluginServerHandlerPtr_
std::vector< SPLPluginInfoT > | valid_plugins_
std::vector< SPLPluginInfoT > | invalid_plugins_
PluginParameters | default_pp_

## Detailed Description

A class to deal with dynamic plugin loading/unloading.

Author:
  Emiliano F. Castejon <castejon@dpi.inpe.br>

## Member Typedef Documentation

typedef std::pair< PluginInfo, long > PluginsManager::SPLPluginInfoT`[protected]`

A definition of loaded plugins info mapping to SPL internal list indexes.

## Constructor & Destructor Documentation

PluginsManager::PluginsManager | ( |  | ) |

Default constructor.

PluginsManager::~PluginsManager | ( |  | ) | `[virtual]`

Default destructor.

## Member Function Documentation

void PluginsManager::getInvalidPluginsList | ( | std::vector< PluginInfo > & | plist | ) | const`[virtual]`

Build a vector of the currently loaded invalid plugins info.

Parameters:

  plist | A output vector reference.

void PluginsManager::getValidPluginsList | ( | std::vector< PluginInfo > & | plist | ) | const`[virtual]`

Build a vector of the currently loaded valid plugins info.

Parameters:

  plist | A output vector reference.

unsigned int PluginsManager::loadPlugins | ( | const std::string & | path | ) | `[virtual]`

Load all plugins from the supplied directory path.

Parameters:

  path | The directory path.

Returns:
  The number of loaded plugins (including invalid/incompatible).

bool PluginsManager::runPlugin | ( | const PluginInfo & | pinfo | ) | const`[virtual]`

Execute a plugin code.

Parameters:

  pinf | The plugin's info.

void PluginsManager::setDefaultPluginsParameters | ( | const PluginParameters & | pp | ) | `[virtual]`

Set the default plugins parameters that will be used when calling the runPlugin function.

void PluginsManager::unloadPlugins | ( |  | ) | `[virtual]`

Unload all plugins.

## Member Data Documentation

PluginParameters PluginsManager::default_pp_`[protected]`

The default plugins parameters that will be used when calling the plugins run function.

std::vector< SPLPluginInfoT > PluginsManager::invalid_plugins_`[protected]`

A vector holding information of all loaded plugins.

void* PluginsManager::pluginServerHandlerPtr_`[protected]`

A pointer to the SPL server.

std::vector< SPLPluginInfoT > PluginsManager::valid_plugins_`[protected]`

A vector holding information of all loaded plugins.

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

- E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/drivers/spl/PluginsManager.h
- E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/drivers/spl/PluginsManager.cpp

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines