Public Member Functions
CPluginHandlerBase Class Referenceabstract

The base class for all plugin handlers. More...

#include <mia/core/handlerbase.hh>

Inheritance diagram for CPluginHandlerBase:
TPluginHandler< I > TPluginHandler< CTestPlugin > TFactoryPluginHandler< I > TIOPluginHandler< I > CTestPluginHandlerImpl

Public Member Functions

void add_dependend_handlers (HandlerHelpMap &handler_map) const
 
 CPluginHandlerBase (const std::string &descriptor)
 
 CPluginHandlerBase (const CPluginHandlerBase &other)=delete
 
const std::string & get_descriptor () const
 
std::string get_handler_type_string () const
 
void get_string_help_description_xml (std::ostream &os, xmlpp::Element *root) const
 
void get_xml_help (xmlpp::Element *root) const
 
CPluginHandlerBaseoperator= (const CPluginHandlerBase &other)=delete
 
void print_help (std::ostream &os) const
 
void print_short_help (std::ostream &os) const
 
virtual ~CPluginHandlerBase ()
 

Detailed Description

The base class for all plugin handlers.

This clas provides some basic funcionallity that is common to all plugin handlers. In addition, the copy constructor and assigment operator are deleted in order to forbit copying of instances of this class.

Definition at line 57 of file handlerbase.hh.

Constructor & Destructor Documentation

CPluginHandlerBase::CPluginHandlerBase ( const std::string &  descriptor)

Constructor

Parameters
descriptorplugin search path descriptor, used to identify the plugin type for users
CPluginHandlerBase::CPluginHandlerBase ( const CPluginHandlerBase other)
delete

forbid copying - doxygen should drop these from the documentation

virtual CPluginHandlerBase::~CPluginHandlerBase ( )
virtual

Member Function Documentation

void CPluginHandlerBase::add_dependend_handlers ( HandlerHelpMap handler_map) const

add all plug-in handler that may be called by this plug-in handler

Parameters
[in,out]handler_mapplug in handler map to add to
const std::string& CPluginHandlerBase::get_descriptor ( ) const
Returns
the plug-in handler descriptor
std::string CPluginHandlerBase::get_handler_type_string ( ) const
void CPluginHandlerBase::get_string_help_description_xml ( std::ostream &  os,
xmlpp::Element *  root 
) const
void CPluginHandlerBase::get_xml_help ( xmlpp::Element *  root) const

Add the help for all plug-ins to the xml tree

Parameters
roottoot element the documentation is added to
CPluginHandlerBase& CPluginHandlerBase::operator= ( const CPluginHandlerBase other)
delete

forbid copying - doxygen should drop these from the documentation

void CPluginHandlerBase::print_help ( std::ostream &  os) const

Print out the help to an output stream

Parameters
os
void CPluginHandlerBase::print_short_help ( std::ostream &  os) const

Print out the short help to an output stream

Parameters
os

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