Diana Software
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
QGeneralFactory Class Reference

This class take care of plugin registration and creation. More...

Inheritance diagram for QGeneralFactory:
QNamed

Public Member Functions

virtual ~QGeneralFactory ()
 
void LoadPlugin (const std::string &name)
 
void Register (QModFactory< QModule > *MF)
 
QModule * CreateModule (const std::string &name, QSequence *s)
 
void Register (QModFactory< QReader > *MF)
 
QReader * CreateReader (const std::string &name, QSequence *s)
 
void Register (QModFactory< QWriter > *MF)
 
QWriter * CreateWriter (const std::string &name, QSequence *s)
 
void Register (QModFactory< QFilter > *MF)
 
QFilter * CreateFilter (const std::string &name, QSequence *s)
 
void Register (QModFactory< QDriver > *MF)
 
QDriver * CreateDriver (const std::string &name, QSequence *s)
 
- Public Member Functions inherited from QNamed
 QNamed ()
 
 QNamed (const std::string &Name)
 
virtual ~QNamed ()
 
const std::string & GetName () const
 
void SetName (const std::string &name)
 

Static Public Member Functions

static QGeneralFactory & GetInstance ()
 

Private Member Functions

 QGeneralFactory ()
 

Private Attributes

QDLLLoader * fDLLLoader
 
std::map< std::string, QModFactory< QModule > * > fModules
 
std::map< std::string, QModFactory< QFilter > * > fFilters
 
std::map< std::string, QModFactory< QReader > * > fReaders
 
std::map< std::string, QModFactory< QWriter > * > fWriters
 
std::map< std::string, QModFactory< QDriver > * > fDrivers
 

Detailed Description

This class take care of plugin registration and creation.

Author
Marco Vignati

Each plugin (MyPlugin) must implement a function like this:

void registerInFactoryMyPlugin()

this function creates a MyPluginFactory and register it in the QGeneralFactory.
When at run time an application ask to LoadPlugin("MyPlugin") the QDll system
open the library that contains registerMyPlugin and executes it so that the MyPluginFactory
is automatically created and registered into the QGeneralFactory.
Once a plugin is registered other applications can call the CreatePluginType("MyPlugin") that
in turns call the MyPluginFactory and return a pointer to the newly created MyPlugin instance.

Reference: http://www.nuclex.org/articles/building-a-better-plugin-architecture (Option 1)

Definition at line 43 of file QGeneralFactory.hh.

Constructor & Destructor Documentation

◆ ~QGeneralFactory()

QGeneralFactory::~QGeneralFactory ( )
virtual

Definition at line 26 of file QGeneralFactory.cc.

References fDrivers, fFilters, fModules, fReaders, and fWriters.

◆ QGeneralFactory()

QGeneralFactory::QGeneralFactory ( )
private

Definition at line 13 of file QGeneralFactory.cc.

References QMessageHandler::Debug(), err, fDLLLoader, QDLLLoader::GetInstance(), QNamed::GetName(), QDLLLoader::Init(), QMessageHandler::Panic(), Q_PLUGIN_PREFIX_STR, and QERR_SUCCESS.

Member Function Documentation

◆ CreateDriver()

QDriver * QGeneralFactory::CreateDriver ( const std::string &  name,
QSequence *  s 
)

Definition at line 184 of file QGeneralFactory.cc.

References fDrivers, and LoadPlugin().

Referenced by QModuleFactory::CreateDriver().

◆ CreateFilter()

QFilter * QGeneralFactory::CreateFilter ( const std::string &  name,
QSequence *  s 
)

Definition at line 157 of file QGeneralFactory.cc.

References fFilters, and LoadPlugin().

Referenced by QModuleFactory::CreateFilter().

◆ CreateModule()

QModule * QGeneralFactory::CreateModule ( const std::string &  name,
QSequence *  s 
)

Definition at line 72 of file QGeneralFactory.cc.

References fModules, and LoadPlugin().

Referenced by QModuleFactory::CreateModule().

◆ CreateReader()

QReader * QGeneralFactory::CreateReader ( const std::string &  name,
QSequence *  s 
)

Definition at line 129 of file QGeneralFactory.cc.

References fReaders, and LoadPlugin().

Referenced by QModuleFactory::CreateReader().

◆ CreateWriter()

QWriter * QGeneralFactory::CreateWriter ( const std::string &  name,
QSequence *  s 
)

Definition at line 101 of file QGeneralFactory.cc.

References fWriters, and LoadPlugin().

Referenced by QModuleFactory::CreateWriter().

◆ GetInstance()

Q_BEGIN_NAMESPACE QGeneralFactory & QGeneralFactory::GetInstance ( )
static

Definition at line 7 of file QGeneralFactory.cc.

Referenced by QModuleFactory::CreateDriver(), QModuleFactory::CreateFilter(), QModuleFactory::CreateModule(), QModuleFactory::CreateReader(), and QModuleFactory::CreateWriter().

◆ LoadPlugin()

void QGeneralFactory::LoadPlugin ( const std::string &  name)

Definition at line 52 of file QGeneralFactory.cc.

References err, QMessageHandler::Error(), fDLLLoader, QNamed::GetName(), QDLLLoader::LoadPlugin(), and QERR_SUCCESS.

Referenced by CreateDriver(), CreateFilter(), CreateModule(), CreateReader(), and CreateWriter().

◆ Register() [1/5]

void QGeneralFactory::Register ( QModFactory< QDriver > *  MF)

Definition at line 171 of file QGeneralFactory.cc.

References QMessageHandler::Debug(), fDrivers, QNamed::GetName(), and QModFactory< T >::GetName().

◆ Register() [2/5]

void QGeneralFactory::Register ( QModFactory< QFilter > *  MF)

Definition at line 144 of file QGeneralFactory.cc.

References QMessageHandler::Debug(), fFilters, QNamed::GetName(), and QModFactory< T >::GetName().

◆ Register() [3/5]

void QGeneralFactory::Register ( QModFactory< QModule > *  MF)

Definition at line 59 of file QGeneralFactory.cc.

References QMessageHandler::Debug(), fModules, QNamed::GetName(), and QModFactory< T >::GetName().

◆ Register() [4/5]

void QGeneralFactory::Register ( QModFactory< QReader > *  MF)

Definition at line 116 of file QGeneralFactory.cc.

References QMessageHandler::Debug(), fReaders, QNamed::GetName(), and QModFactory< T >::GetName().

◆ Register() [5/5]

void QGeneralFactory::Register ( QModFactory< QWriter > *  MF)

Definition at line 88 of file QGeneralFactory.cc.

References QMessageHandler::Debug(), fWriters, QNamed::GetName(), and QModFactory< T >::GetName().

Member Data Documentation

◆ fDLLLoader

QDLLLoader* QGeneralFactory::fDLLLoader
private

Definition at line 68 of file QGeneralFactory.hh.

Referenced by LoadPlugin(), and QGeneralFactory().

◆ fDrivers

std::map<std::string, QModFactory<QDriver>* > QGeneralFactory::fDrivers
private

Definition at line 74 of file QGeneralFactory.hh.

Referenced by CreateDriver(), Register(), and ~QGeneralFactory().

◆ fFilters

std::map<std::string, QModFactory<QFilter>* > QGeneralFactory::fFilters
private

Definition at line 71 of file QGeneralFactory.hh.

Referenced by CreateFilter(), Register(), and ~QGeneralFactory().

◆ fModules

std::map<std::string, QModFactory<QModule>* > QGeneralFactory::fModules
private

Definition at line 70 of file QGeneralFactory.hh.

Referenced by CreateModule(), Register(), and ~QGeneralFactory().

◆ fReaders

std::map<std::string, QModFactory<QReader>* > QGeneralFactory::fReaders
private

Definition at line 72 of file QGeneralFactory.hh.

Referenced by CreateReader(), Register(), and ~QGeneralFactory().

◆ fWriters

std::map<std::string, QModFactory<QWriter>* > QGeneralFactory::fWriters
private

Definition at line 73 of file QGeneralFactory.hh.

Referenced by CreateWriter(), Register(), and ~QGeneralFactory().

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.1