Wolframe, 0.0.3

_Wolframe::module::ConfiguredBuilder Class Referenceabstract

Builder for objects with configuration. More...

#include <moduleInterface.hpp>

Inheritance diagram for _Wolframe::module::ConfiguredBuilder:
_Wolframe::module::BuilderBase _Wolframe::module::ConfiguredBuilderDescription< Tconstructor, Tconf >

Public Member Functions

 ConfiguredBuilder (const char *title, const char *section, const char *keyword, const char *className)
 Constructor. More...
 
virtual ~ConfiguredBuilder ()
 
virtual const char * objectClassName () const
 
virtual
ObjectConstructorBase::ObjectType 
objectType () const =0
 Get the type of the object: filter, audit, command handler etc. This is not the same as the objectName. More...
 
virtual
config::NamedConfiguration
configuration (const char *logPrefix)=0
 Get the configuration for the object. More...
 
virtual ObjectConstructorBaseconstructor ()=0
 get the virtual constructor for the object More...
 
- Public Member Functions inherited from _Wolframe::module::BuilderBase
virtual ~BuilderBase ()
 

Protected Attributes

const char * m_title
 used for printing (logging etc.) More...
 
const char * m_section
 
const char * m_keyword
 
const char * m_className
 

Friends

class ModulesDirectory
 

Detailed Description

Builder for objects with configuration.

Constructor & Destructor Documentation

_Wolframe::module::ConfiguredBuilder::ConfiguredBuilder ( const char *  title,
const char *  section,
const char *  keyword,
const char *  className 
)
inline

Constructor.

Parameters
titlestring used for printing purposes, usually logging.
sectionconfiguration section (parent node)
keywordkeyword in the configuration section. The object configuration is bind to the section, keyword pair
classNamethe name of the class that the built constructor will build
virtual _Wolframe::module::ConfiguredBuilder::~ConfiguredBuilder ( )
inlinevirtual

Member Function Documentation

virtual config::NamedConfiguration* _Wolframe::module::ConfiguredBuilder::configuration ( const char *  logPrefix)
pure virtual

Get the configuration for the object.

Parameters
logPrefixstring to print before the log messages generated inside this object. Same as for any confiuration object.

Implemented in _Wolframe::module::ConfiguredBuilderDescription< Tconstructor, Tconf >.

virtual ObjectConstructorBase* _Wolframe::module::ConfiguredBuilder::constructor ( )
pure virtual

get the virtual constructor for the object

Implements _Wolframe::module::BuilderBase.

Implemented in _Wolframe::module::ConfiguredBuilderDescription< Tconstructor, Tconf >.

virtual const char* _Wolframe::module::ConfiguredBuilder::objectClassName ( ) const
inlinevirtual
virtual ObjectConstructorBase::ObjectType _Wolframe::module::ConfiguredBuilder::objectType ( ) const
pure virtual

Get the type of the object: filter, audit, command handler etc. This is not the same as the objectName.

Implements _Wolframe::module::BuilderBase.

Implemented in _Wolframe::module::ConfiguredBuilderDescription< Tconstructor, Tconf >.

Friends And Related Function Documentation

friend class ModulesDirectory
friend

Member Data Documentation

const char* _Wolframe::module::ConfiguredBuilder::m_className
protected
const char* _Wolframe::module::ConfiguredBuilder::m_keyword
protected
const char* _Wolframe::module::ConfiguredBuilder::m_section
protected

configuration section to which the configuration parser reacts

const char* _Wolframe::module::ConfiguredBuilder::m_title
protected

used for printing (logging etc.)


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