IFactory< Key, AbstractProduct > Class Template Reference

Description

template<class Key, class AbstractProduct>
class IFactory< Key, AbstractProduct >

Base class for all factories.

Definition at line 29 of file IFactory.h.

Collaboration diagram for IFactory< Key, AbstractProduct >:

Public Types
using	CallbackMap_t = std::map< Key, CreateItemCallback >
	map for correspondence between object identifier and object creation function More...
using	CreateItemCallback = std::function< AbstractProduct *()>
	function which will be used to create object of AbstractProduct base type More...

Public Member Functions
bool	contains (const Key &item_key) const
AbstractProduct *	createItem (const Key &item_key) const
	Creates object by calling creation function corresponded to given identifier. More...
std::unique_ptr< AbstractProduct >	createItemPtr (const Key &item_key) const
bool	registerItem (const Key &item_key, CreateItemCallback CreateFn)
	Registers object's creation function. More...
size_t	size () const
	Returns number of registered objects. More...

Protected Attributes
CallbackMap_t	m_callbacks
	map of correspondence of objectsId and creation functions More...

Member Typedef Documentation

CallbackMap_t

template<class Key , class AbstractProduct >

using IFactory< Key, AbstractProduct >::CallbackMap_t = std::map<Key, CreateItemCallback>

map for correspondence between object identifier and object creation function

Definition at line 35 of file IFactory.h.

CreateItemCallback

template<class Key , class AbstractProduct >

using IFactory< Key, AbstractProduct >::CreateItemCallback = std::function<AbstractProduct*()>

function which will be used to create object of AbstractProduct base type

Definition at line 32 of file IFactory.h.

Member Function Documentation

contains()

template<class Key , class AbstractProduct >

bool IFactory< Key, AbstractProduct >::contains ( const Key &  item_key ) const

inline

Definition at line 57 of file IFactory.h.

    {
        return m_callbacks.find(item_key) != m_callbacks.end();
    }

References IFactory< Key, AbstractProduct >::m_callbacks.

createItem()

template<class Key , class AbstractProduct >

AbstractProduct* IFactory< Key, AbstractProduct >::createItem ( const Key &  item_key ) const

inline

Creates object by calling creation function corresponded to given identifier.

Definition at line 38 of file IFactory.h.

    {
        auto it = m_callbacks.find(item_key);
        assert(it != m_callbacks.end());
        return (it->second)();
    }

References IFactory< Key, AbstractProduct >::m_callbacks.

Referenced by IFactory< Key, AbstractProduct >::createItemPtr().

createItemPtr()

template<class Key , class AbstractProduct >

std::unique_ptr<AbstractProduct> IFactory< Key, AbstractProduct >::createItemPtr ( const Key &  item_key ) const

inline

Definition at line 45 of file IFactory.h.

    {
        return std::unique_ptr<AbstractProduct>{createItem(item_key)};
    }

References IFactory< Key, AbstractProduct >::createItem().

Here is the call graph for this function:

registerItem()

template<class Key , class AbstractProduct >

bool IFactory< Key, AbstractProduct >::registerItem ( const Key &  item_key, CreateItemCallback  CreateFn  )

inline

Registers object's creation function.

Definition at line 51 of file IFactory.h.

    {
        assert(m_callbacks.find(item_key) == m_callbacks.end());
        return m_callbacks.insert(make_pair(item_key, CreateFn)).second;
    }

References IFactory< Key, AbstractProduct >::m_callbacks.

size()

template<class Key , class AbstractProduct >

size_t IFactory< Key, AbstractProduct >::size ( ) const

inline

Returns number of registered objects.

Definition at line 63 of file IFactory.h.

{ return m_callbacks.size(); }

References IFactory< Key, AbstractProduct >::m_callbacks.

Member Data Documentation

m_callbacks

template<class Key , class AbstractProduct >

CallbackMap_t IFactory< Key, AbstractProduct >::m_callbacks

protected

map of correspondence of objectsId and creation functions

Definition at line 66 of file IFactory.h.

Referenced by IFactory< Key, AbstractProduct >::contains(), IFactory< Key, AbstractProduct >::createItem(), IFactory< Key, AbstractProduct >::registerItem(), and IFactory< Key, AbstractProduct >::size().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Base/Util/IFactory.h