boostx::factory< INTERFACE, TYPEINFO, ARGS > Struct Template Reference

The central factory class. More...

#include <factory.hpp>

Public Types
typedef INTERFACE	interface_type
	Typedef for our abstract interface. More...
typedef factory < interface_type, TYPEINFO, ARGS...>	type
	Typedef for this factory type. More...
template<typename T >
using	typeinfo_type = TYPEINFO< T >
	Template alias for typeinfo type. More...
typedef typeinfo_type < interface_type > ::typeid_type	key_type
	Get key type from typeinfo struct. More...
typedef std::function < interface_type *(ARGS...)>	constructor_type
	Constructor function type. More...
typedef std::unordered_map < key_type, constructor_type >	class_map_type
	Internal type of map for storing ids. More...
template<typename T >
using	registrar_type = registrar< T, type, ARGS...>
	Alias template for registar. More...

Static Public Member Functions
static bool	exists (const key_type &_key)
	Checks if class with element id is registered. More...
template<typename T >
static void	reg (const key_type &_key)
	Registers class with custom key. More...
template<typename T >
static void	reg ()
	Registers class by getting key from registrar's type id. More...
static void	unreg (const key_type &_key)
	Unregisters class with custom key. More...
template<typename T >
static void	unreg ()
	Unregisters class by getting key from registrar. More...
static interface_type *	create (const key_type &_key, const ARGS &..._args)
	Instantiates an object of the class by id and constructor arguments. More...
static class_map_type const &	classes ()
	Gives readonly access to registered classes. More...

Static Private Member Functions
template<typename T >
static void	key_type_check ()
	Checks if key types are the same. More...
static class_map_type &	private_classes ()

Detailed Description

template<typename INTERFACE, template< class > class TYPEINFO, typename... ARGS>
struct boostx::factory< INTERFACE, TYPEINFO, ARGS >

The central factory class.

Template Parameters

INTERFACE	Typename of the abstract interface
TYPEINFO	Template template parameter for the typeinfo
...ARGS	Template parameter which comply to the constructor signature of the interface

Member Typedef Documentation

template<typename INTERFACE , template< class > class TYPEINFO, typename... ARGS>

typedef std::unordered_map<key_type,constructor_type> boostx::factory< INTERFACE, TYPEINFO, ARGS >::class_map_type

Internal type of map for storing ids.

template<typename INTERFACE , template< class > class TYPEINFO, typename... ARGS>

typedef std::function<interface_type*(ARGS...)> boostx::factory< INTERFACE, TYPEINFO, ARGS >::constructor_type

Constructor function type.

template<typename INTERFACE , template< class > class TYPEINFO, typename... ARGS>

typedef INTERFACE boostx::factory< INTERFACE, TYPEINFO, ARGS >::interface_type

Typedef for our abstract interface.

template<typename INTERFACE , template< class > class TYPEINFO, typename... ARGS>

typedef typeinfo_type<interface_type>::typeid_type boostx::factory< INTERFACE, TYPEINFO, ARGS >::key_type

Get key type from typeinfo struct.

template<typename INTERFACE , template< class > class TYPEINFO, typename... ARGS>

template<typename T >

using boostx::factory< INTERFACE, TYPEINFO, ARGS >::registrar_type = registrar<T,type,ARGS...>

Alias template for registar.

template<typename INTERFACE , template< class > class TYPEINFO, typename... ARGS>

typedef factory<interface_type,TYPEINFO,ARGS...> boostx::factory< INTERFACE, TYPEINFO, ARGS >::type

Typedef for this factory type.

template<typename INTERFACE , template< class > class TYPEINFO, typename... ARGS>

template<typename T >

using boostx::factory< INTERFACE, TYPEINFO, ARGS >::typeinfo_type = TYPEINFO<T>

Template alias for typeinfo type.

Member Function Documentation

template<typename INTERFACE , template< class > class TYPEINFO, typename... ARGS>

static class_map_type const& boostx::factory< INTERFACE, TYPEINFO, ARGS >::classes ( )

inlinestatic

Gives readonly access to registered classes.

    {
      return private_classes();
    }

template<typename INTERFACE , template< class > class TYPEINFO, typename... ARGS>

static interface_type* boostx::factory< INTERFACE, TYPEINFO, ARGS >::create ( const key_type &  _key, const ARGS &...  _args  )

inlinestatic

Instantiates an object of the class by id and constructor arguments.

    {
      if (!exists(_key)) return nullptr;
      return private_classes()[_key](_args...);
    }

template<typename INTERFACE , template< class > class TYPEINFO, typename... ARGS>

static bool boostx::factory< INTERFACE, TYPEINFO, ARGS >::exists ( const key_type &  _key )

inlinestatic

Checks if class with element id is registered.

    {
      return private_classes().count(_key) > 0;
    }

template<typename INTERFACE , template< class > class TYPEINFO, typename... ARGS>

template<typename T >

static void boostx::factory< INTERFACE, TYPEINFO, ARGS >::key_type_check ( )

inlinestaticprivate

Checks if key types are the same.

    {
      // Check if T is a base class of interface
      static_assert(std::is_base_of<interface_type,T>::value,
          "Given type T must be a base class of the interface class");

      // Check if registrar's type id and key type are the same
      typedef std::is_same<decltype(registrar_type<T>::type_id()),key_type> is_same_type;
      static_assert(is_same_type::value,
          "Type of type id to be registered and registrys type id must be equal!");
    }

template<typename INTERFACE , template< class > class TYPEINFO, typename... ARGS>

static class_map_type& boostx::factory< INTERFACE, TYPEINFO, ARGS >::private_classes ( )

inlinestaticprivate

    {
      static class_map_type _classes;
      return _classes;
    }

template<typename INTERFACE , template< class > class TYPEINFO, typename... ARGS>

template<typename T >

static void boostx::factory< INTERFACE, TYPEINFO, ARGS >::reg ( const key_type &  _key )

inlinestatic

Registers class with custom key.

    {
      if (exists(_key)) return;
      private_classes()[_key] = registrar_type<T>::create;
    }

template<typename INTERFACE , template< class > class TYPEINFO, typename... ARGS>

template<typename T >

static void boostx::factory< INTERFACE, TYPEINFO, ARGS >::reg ( )

inlinestatic

Registers class by getting key from registrar's type id.

    {
      key_type_check<T>();
      reg<T>(registrar_type<T>::type_id());
    }

template<typename INTERFACE , template< class > class TYPEINFO, typename... ARGS>

static void boostx::factory< INTERFACE, TYPEINFO, ARGS >::unreg ( const key_type &  _key )

inlinestatic

Unregisters class with custom key.

    {
      if (!exists(_key)) return;
      private_classes().erase(_key);
    }

template<typename INTERFACE , template< class > class TYPEINFO, typename... ARGS>

template<typename T >

static void boostx::factory< INTERFACE, TYPEINFO, ARGS >::unreg ( )

inlinestatic

Unregisters class by getting key from registrar.

    {
      key_type_check<T>();
      unreg(registrar_type<T>::type_id());
    }

---

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

• include/boostx/factory.hpp