te::plugin::CppPluginEngineFactory Class Reference

This is the concrete factory for C++ plugin engines. More...

#include <CppPluginEngineFactory.h>

Inheritance diagram for te::plugin::CppPluginEngineFactory:
te::plugin::PluginEngineFactory te::common::AbstractFactory< AbstractPluginEngine, std::string >

Public Types

typedef FactoryDictionary< AbstractFactory< AbstractPluginEngine, std::string, std::less< std::string > >, std::string, std::less< std::string > > dictionary_type
 
typedef AbstractFactory factory_type
 

Public Member Functions

const std::string & getKey () const
 It returns the factory key associated to the concreate factory. More...
 

Static Public Member Functions

static const factory_typefind (const std::string &factoryKey)
 
static dictionary_typegetDictionary ()
 It returns a reference to the internal dictionary of concrete factories. More...
 
static AbstractPluginEnginemake (const std::string &factoryKey)
 It creates an object with the appropriated factory. More...
 

Protected Member Functions

AbstractPluginEnginebuild ()
 It creates a new plugin engine for C++. More...
 
 CppPluginEngineFactory ()
 
 ~CppPluginEngineFactory ()
 Destructor. More...
 

Protected Attributes

std::string m_factoryKey
 The key that identifies the concrete factory: it will be used for unregistering the factory during destruction. More...
 

Static Private Attributes

static CppPluginEngineFactory sm_factory
 The C++ plugin engine factory. More...
 

Detailed Description

This is the concrete factory for C++ plugin engines.

See also
PluginEngineFactory, AbstractFactory, PluginEngine, Plugin

Definition at line 43 of file CppPluginEngineFactory.h.

Member Typedef Documentation

typedef FactoryDictionary<AbstractFactory<AbstractPluginEngine , std::string , std::less<std::string > >, std::string , std::less<std::string > > te::common::AbstractFactory< AbstractPluginEngine , std::string , std::less<std::string > >::dictionary_type
inherited

Definition at line 73 of file AbstractFactory.h.

typedef AbstractFactory te::common::AbstractFactory< AbstractPluginEngine , std::string , std::less<std::string > >::factory_type
inherited

Definition at line 77 of file AbstractFactory.h.

Constructor & Destructor Documentation

te::plugin::CppPluginEngineFactory::CppPluginEngineFactory ( )
protected

It register the factory in the abstract dictionary.

te::plugin::CppPluginEngineFactory::~CppPluginEngineFactory ( )
protected

Destructor.

Member Function Documentation

AbstractPluginEngine* te::plugin::CppPluginEngineFactory::build ( )
protectedvirtual

It creates a new plugin engine for C++.

Returns
It returns plugin engine for C++.

Implements te::common::AbstractFactory< AbstractPluginEngine, std::string >.

static const factory_type* te::common::AbstractFactory< AbstractPluginEngine , std::string , std::less<std::string > >::find ( const std::string &  factoryKey)
staticinherited
static dictionary_type& te::common::AbstractFactory< AbstractPluginEngine , std::string , std::less<std::string > >::getDictionary ( )
staticinherited

It returns a reference to the internal dictionary of concrete factories.

The dictionary is a singleton.

Returns
A reference to the internal dictionary.
const std::string & te::common::AbstractFactory< AbstractPluginEngine , std::string , std::less<std::string > >::getKey ( ) const
inherited

It returns the factory key associated to the concreate factory.

Returns
The factory key associated to the concreate factory.
static AbstractPluginEngine * te::common::AbstractFactory< AbstractPluginEngine , std::string , std::less<std::string > >::make ( const std::string &  factoryKey)
staticinherited

It creates an object with the appropriated factory.

Parameters
factoryKeyA key that identifies the factory used to build the object.
Returns
It returns a new object created by the given factory.
Exceptions
ExceptionIf the concrete factory is not specified or the object can not be built for any reason this methiod may throws an exception.
Note
The caller of this method will take the ownership of the returned object.

Member Data Documentation

std::string te::common::AbstractFactory< AbstractPluginEngine , std::string , std::less<std::string > >::m_factoryKey
protectedinherited

The key that identifies the concrete factory: it will be used for unregistering the factory during destruction.

Definition at line 136 of file AbstractFactory.h.

CppPluginEngineFactory te::plugin::CppPluginEngineFactory::sm_factory
staticprivate

The C++ plugin engine factory.

Definition at line 62 of file CppPluginEngineFactory.h.


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