MFactory< AbstractProduct, IdentifierType, ReturnType, ProductCreator, Args > Class Template Reference

Class implementing the object factory pattern. More...

#include <factory.h>

Inheritance diagram for MFactory< AbstractProduct, IdentifierType, ReturnType, ProductCreator, Args >:

Collaboration diagram for MFactory< AbstractProduct, IdentifierType, ReturnType, ProductCreator, Args >:

Public Member Functions
MBool	add (const IdentifierType &id, ProductCreator creator)
	Function to add new types to the factory. More...
MBool	remove (const IdentifierType &id)
	Function to remove existing types from the factory. More...
ReturnType	create (const IdentifierType &id, Args... args) const
	Function to create a new instance of a type. More...

Private Types
typedef std::map< IdentifierType, ProductCreator >	AssocMap

Private Attributes
AssocMap	m_assoc

Detailed Description

template<class AbstractProduct, typename IdentifierType, typename ReturnType = std::unique_ptr<AbstractProduct>, class ProductCreator = std::function<ReturnType()>, class... Args>
class MFactory< AbstractProduct, IdentifierType, ReturnType, ProductCreator, Args >

Author

Michael Schlottke (mic) mic@a.nosp@m.ia.r.nosp@m.wth-a.nosp@m.ache.nosp@m.n.de

Date

2014-04-05

Template Parameters

AbstractProduct	The (abstract) base class of the objects to be created.
IdentifierType	The type to be used to identify derived types.
ReturnType	Return type of the create() method.
ProductCreator	The type of the creating function.
Args	Additional (optional) arguments that should be passed to the constructor of the created objects.

This follow the factory pattern as described in Alexandrescu (2001).

References: Andrei Alexandrescu (2001): Modern C++ Design.

Definition at line 36 of file factory.h.

Member Typedef Documentation

AssocMap

template<class AbstractProduct , typename IdentifierType , typename ReturnType = std::unique_ptr<AbstractProduct>, class ProductCreator = std::function<ReturnType()>, class... Args>

typedef std::map<IdentifierType, ProductCreator> MFactory< AbstractProduct, IdentifierType, ReturnType, ProductCreator, Args >::AssocMap

private

Definition at line 71 of file factory.h.

Member Function Documentation

add()

template<class AbstractProduct , typename IdentifierType , typename ReturnType = std::unique_ptr<AbstractProduct>, class ProductCreator = std::function<ReturnType()>, class... Args>

MBool MFactory< AbstractProduct, IdentifierType, ReturnType, ProductCreator, Args >::add ( const IdentifierType &  id, ProductCreator  creator  )

inline

Parameters

[in]	id	Identifier for newly added type.
[in]	creator	Function returning a new instance of the new type.

Returns

True if the type was sucessfully added.

Definition at line 44 of file factory.h.

                                                              {
    return m_assoc.insert(typename AssocMap::value_type(id, creator)).second;
  }

create()

template<class AbstractProduct , typename IdentifierType , typename ReturnType = std::unique_ptr<AbstractProduct>, class ProductCreator = std::function<ReturnType()>, class... Args>

ReturnType MFactory< AbstractProduct, IdentifierType, ReturnType, ProductCreator, Args >::create ( const IdentifierType &  id, Args...  args  ) const

inline

Parameters

[in]	id	Identifier of the type to be created.
[in]	args	Optional arguments to be passed to the type's constructor.

Returns

A handle to the newly created object.

Definition at line 61 of file factory.h.

                                                                  {
    auto i = m_assoc.find(id);
    if(i != m_assoc.end()) {
      return (i->second)(args...);
    } else {
      TERMM(1, "Identifier not found.");
    }
  }

remove()

template<class AbstractProduct , typename IdentifierType , typename ReturnType = std::unique_ptr<AbstractProduct>, class ProductCreator = std::function<ReturnType()>, class... Args>

MBool MFactory< AbstractProduct, IdentifierType, ReturnType, ProductCreator, Args >::remove ( const IdentifierType &  id )

inline

Parameters

[in]

id

Identifier for the type to be removed.

Returns

True if the type was sucessfully removed.

Definition at line 53 of file factory.h.

{ return m_assoc.erase(id) == true; }

Member Data Documentation

m_assoc

template<class AbstractProduct , typename IdentifierType , typename ReturnType = std::unique_ptr<AbstractProduct>, class ProductCreator = std::function<ReturnType()>, class... Args>

AssocMap MFactory< AbstractProduct, IdentifierType, ReturnType, ProductCreator, Args >::m_assoc

private

Definition at line 72 of file factory.h.

---

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

• /home/gitlab-runner/scratch/builds/oxpnswJ6/1/aia/m-AIA/m-AIA/src/factory.h