ug4
Classes | Public Member Functions | Private Types | Private Attributes | List of all members
ug::Factory< TBase, TPairSeq > Class Template Reference

A factory class which creates instances given a class-name. More...

#include <factory.h>

Classes

struct  ClassInfo
 

Public Member Functions

const std::string & class_name (const size_t i) const
 
const std::string & class_name (const TBase &cls) const
 
SmartPtr< TBase > create (const char *className)
 
SmartPtr< TBase > create (const std::string &className)
 
TBase * create_raw (const char *className)
 
TBase * create_raw (const std::string &className)
 
 Factory ()
 
size_t num_classes () const
 
template<class TDerived >
void register_class (const char *name)
 

Private Types

typedef std::map< std::string, ClassInfo > class_map_t
 
typedef std::map< std::string, std::string > class_name_map_t
 
typedef TBase *(* factory_sig) ()
 

Private Attributes

class_map_t m_classMap
 contains ClassInfo objects accessible by class-name. More...
 
class_name_map_t m_classNameMap
 key: type-name, value: class-names More...
 
std::vector< std::string > m_classNames
 

Detailed Description

template<class TBase, class TPairSeq = boost::mpl::vector<>>
class ug::Factory< TBase, TPairSeq >

A factory class which creates instances given a class-name.

Given a base-class 'TBase' and an optional boost::mpl sequence of pairs of derived classes and strings 'TPairSeq', the ug::Factory class allows for the creation of instances ofderived classes given a name. Additionally to the classes contained in 'TPairSeq', one may register derived classes at runtime through the 'register_class' method.

Besides creation of registered classes through the 'create' method, one can iterate over all registered classes or obtain a registered class-name given a pointer to the base class.

Note
This factory class is somewhat limited compared to e.g. to boost::factory and is not meant as a replacement. It's main purpose is to allow iteration over registered classes and to perform automatic registration through a type list.

Member Typedef Documentation

◆ class_map_t

template<class TBase , class TPairSeq = boost::mpl::vector<>>
typedef std::map<std::string, ClassInfo> ug::Factory< TBase, TPairSeq >::class_map_t
private

◆ class_name_map_t

template<class TBase , class TPairSeq = boost::mpl::vector<>>
typedef std::map<std::string, std::string> ug::Factory< TBase, TPairSeq >::class_name_map_t
private

◆ factory_sig

template<class TBase , class TPairSeq = boost::mpl::vector<>>
typedef TBase*(* ug::Factory< TBase, TPairSeq >::factory_sig) ()
private

Constructor & Destructor Documentation

◆ Factory()

template<class TBase , class TPairSeq = boost::mpl::vector<>>
ug::Factory< TBase, TPairSeq >::Factory ( )
inline

References func().

Member Function Documentation

◆ class_name() [1/2]

template<class TBase , class TPairSeq = boost::mpl::vector<>>
const std::string& ug::Factory< TBase, TPairSeq >::class_name ( const size_t  i) const
inline

References ug::Factory< TBase, TPairSeq >::m_classNames.

Referenced by ug::GridWriterUGX::create_projector_node(), ug::IDomain< TGrid, TSubsetHandler >::serialize_projector(), and ug::SerializeProjector().

◆ class_name() [2/2]

template<class TBase , class TPairSeq = boost::mpl::vector<>>
const std::string& ug::Factory< TBase, TPairSeq >::class_name ( const TBase &  cls) const
inline

References ug::Factory< TBase, TPairSeq >::m_classNameMap, and name.

◆ create() [1/2]

template<class TBase , class TPairSeq = boost::mpl::vector<>>
SmartPtr<TBase> ug::Factory< TBase, TPairSeq >::create ( const char *  className)
inline

References ug::Factory< TBase, TPairSeq >::create_raw().

◆ create() [2/2]

template<class TBase , class TPairSeq = boost::mpl::vector<>>
SmartPtr<TBase> ug::Factory< TBase, TPairSeq >::create ( const std::string &  className)
inline

Referenced by ug::IDomain< TGrid, TSubsetHandler >::deserialize_projector(), ug::DeserializeProjector(), and ug::GridReaderUGX::read_projector().

◆ create_raw() [1/2]

template<class TBase , class TPairSeq = boost::mpl::vector<>>
TBase* ug::Factory< TBase, TPairSeq >::create_raw ( const char *  className)
inline

References ug::Factory< TBase, TPairSeq >::m_classMap, and UG_COND_THROW.

◆ create_raw() [2/2]

template<class TBase , class TPairSeq = boost::mpl::vector<>>
TBase* ug::Factory< TBase, TPairSeq >::create_raw ( const std::string &  className)
inline

Referenced by ug::Factory< TBase, TPairSeq >::create().

◆ num_classes()

template<class TBase , class TPairSeq = boost::mpl::vector<>>
size_t ug::Factory< TBase, TPairSeq >::num_classes ( ) const
inline

References ug::Factory< TBase, TPairSeq >::m_classNames.

◆ register_class()

template<class TBase , class TPairSeq = boost::mpl::vector<>>
template<class TDerived >
void ug::Factory< TBase, TPairSeq >::register_class ( const char *  name)
inline

References ug::bridge::ClassInfo(), ug::Factory< TBase, TPairSeq >::m_classMap, ug::Factory< TBase, TPairSeq >::m_classNameMap, ug::Factory< TBase, TPairSeq >::m_classNames, and name.

Member Data Documentation

◆ m_classMap

template<class TBase , class TPairSeq = boost::mpl::vector<>>
class_map_t ug::Factory< TBase, TPairSeq >::m_classMap
private

contains ClassInfo objects accessible by class-name.

Referenced by ug::Factory< TBase, TPairSeq >::create_raw(), and ug::Factory< TBase, TPairSeq >::register_class().

◆ m_classNameMap

template<class TBase , class TPairSeq = boost::mpl::vector<>>
class_name_map_t ug::Factory< TBase, TPairSeq >::m_classNameMap
private

key: type-name, value: class-names

Referenced by ug::Factory< TBase, TPairSeq >::class_name(), and ug::Factory< TBase, TPairSeq >::register_class().

◆ m_classNames

template<class TBase , class TPairSeq = boost::mpl::vector<>>
std::vector<std::string> ug::Factory< TBase, TPairSeq >::m_classNames
private

Referenced by ug::Factory< TBase, TPairSeq >::class_name(), ug::Factory< TBase, TPairSeq >::num_classes(), and ug::Factory< TBase, TPairSeq >::register_class().

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