Public Types | Public Member Functions | Static Public Member Functions
TPlugin< D, T > Class Template Reference

The generic base for all plug-ins. More...

#include <mia/core/plugin_base.hh>

Inheritance diagram for TPlugin< D, T >:
CPluginBase

Public Types

typedef D PlugData
 Typedef for the data type descriptor handled by this plug-in.
typedef T PlugType
 Typedef for the plugin type descriptor handled by this plug-in.

Public Member Functions

virtual void get_help (std::ostream &os) const
const std::string get_long_name () const
 TPlugin (const char *name)
- Public Member Functions inherited from CPluginBase
void add_dependend_handlers (HandlerHelpMap &handler_map)
void add_parameter (const std::string &name, CParameter *param)
void append_interface (CPluginBase *plugin)
void check_parameters ()
 CPluginBase (const char *name)
const std::string get_descr () const
void get_help_xml (xmlpp::Element &root) const
PPluginModule get_module () const
const char * get_name () const
void get_short_help (std::ostream &os) const
bool has_property (const char *property) const
CPluginBasenext_interface ()
void set_module (const PPluginModule &module)
void set_parameters (const CParsedOptions &options)
virtual ~CPluginBase ()

Static Public Member Functions

::boost::filesystem::path search_path ()

Additional Inherited Members

- Protected Member Functions inherited from CPluginBase
void add_property (const char *property)

Detailed Description

template<typename D, typename T>
class TPlugin< D, T >

The generic base for all plug-ins.

Templated plugin base class. The classes D and T must define a static const char *data_descr and static const char *type_descr respectively. The combination D::data_descr and T::type_descr is will be part of the plugin search path.

Template Parameters
Ddata type descriptior
Tplugin type descriptor

Definition at line 213 of file plugin_base.hh.

Member Typedef Documentation

template<typename D, typename T>
typedef D TPlugin< D, T >::PlugData

Typedef for the data type descriptor handled by this plug-in.

Definition at line 216 of file plugin_base.hh.

template<typename D, typename T>
typedef T TPlugin< D, T >::PlugType

Typedef for the plugin type descriptor handled by this plug-in.

Definition at line 219 of file plugin_base.hh.

Constructor & Destructor Documentation

template<typename D, typename T>
TPlugin< D, T >::TPlugin ( const char *  name)

The constructor initialises the plug-in with its name and sets its link-up to nil ant initialises its parameter map.

Parameters
name

Member Function Documentation

template<typename D, typename T>
virtual void TPlugin< D, T >::get_help ( std::ostream &  os) const
virtual

Write a help regarding the plugin to the output stream

Parameters
os

Reimplemented from CPluginBase.

template<typename D, typename T>
const std::string TPlugin< D, T >::get_long_name ( ) const
Returns
the long name of the plug in consisting of its name, its type, and data descriptors
template<typename D, typename T>
::boost::filesystem::path TPlugin< D, T >::search_path ( )
static
Returns
the plugin specific part of the plugin search path

Reimplemented in CTestPlugin.


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