GGSFactory< T, ConstructorArgs > Class Template Reference

Template factory class. More...

#include <GGSFactory.h>

Public Member Functions
bool	RegisterBuilder (const std::string &builderName, T *(*objectBuilder)(ConstructorArgs...))
	Register a builder for a class. More...
std::unique_ptr< T >	CreateObject (const std::string &name, ConstructorArgs...arguments)
	Create an object. More...
const std::vector< std::string > &	GetListOfRegisteredBuilders ()
	Gets a vector containing the names of available registered builders. More...

Static Public Member Functions
static GGSFactory &	GetInstance ()
	Getter method for singleton pointer. More...

Detailed Description

template<class T, typename... ConstructorArgs>
class GGSFactory< T, ConstructorArgs >

Template factory class.

This class is a generic factory, that can build all the derived classes of a given base class using constructors with any set of arguments. The first template argument is the base class of the objects built by the factory. Variadic template arguments are the constructor arguments. Actual object build is done by means of builder functions, each constructing instances of a given derived class. Builders must be registered providing a suitable builder function with a name (which can be the name of the built class itself).

Definition at line 30 of file GGSFactory.h.

Member Function Documentation

template<class T , typename... ConstructorArgs>

std::unique_ptr< T > GGSFactory< T, ConstructorArgs >::CreateObject	(	const std::string &	name,
		ConstructorArgs...	arguments
	)

Create an object.

The builder is fetched by its name. If the desired builder is not available, the NULL pointer will be returned.

Parameters

name	The name of the builder for the desired object.

Returns

a pointer to an instance of the derived class created by the builder (NULL if any error occurs).

Definition at line 123 of file GGSFactory.h.

                                   {
  const std::string &routineName(_factoryName + "::CreateObject");

  // 1. Search for a suitable builder
  typename BuildersMap::iterator builderIter = _builders.find(builderName);
  if (builderIter == _builders.end()) {
    COUT(ERROR) << "No available class builder with name " << builderName << "." << ENDL;
    return std::unique_ptr<T>((T*)(NULL));
  }

  // 2. Build the object and return it
  return std::unique_ptr<T>((*(builderIter->second))(arguments...));

}

template<class T , typename... ConstructorArgs>

GGSFactory< T, ConstructorArgs...> & GGSFactory< T, ConstructorArgs >::GetInstance ( )

static

Getter method for singleton pointer.

Returns

pointer to the singleton instance of the GGSFactory class.

Definition at line 75 of file GGSFactory.h.

                                                                                  {
  static GGSFactory<T, ConstructorArgs...> instance;
  return instance;
}

template<class T , typename... ConstructorArgs>

const std::vector< std::string > & GGSFactory< T, ConstructorArgs >::GetListOfRegisteredBuilders

(

)

Gets a vector containing the names of available registered builders.

Returns

a vector with the names of registered builders.

Definition at line 118 of file GGSFactory.h.

                                                                                           {
  return _builderNames;
}

template<class T , typename... ConstructorArgs>

bool GGSFactory< T, ConstructorArgs >::RegisterBuilder	(	const std::string &	builderName,
		T *(*)(ConstructorArgs...)	objectBuilder
	)

Register a builder for a class.

Parameters

builderName	The name of the builder.
objectBuilder	Pointer to a builder function for the class.

Returns

true if the class has been correctly registered.

Definition at line 99 of file GGSFactory.h.

                                             {
  const std::string &routineName(_factoryName + "::RegisterBuilder");

  std::pair<typename BuildersMap::iterator, bool> insertResult = _builders.insert(
      std::pair<std::string, T *(*)(ConstructorArgs...)>(builderName, objectBuilder));
  if (insertResult.second) {
    _builderNames.push_back(builderName);
    COUT(DEBUG) << "Registered builder " << builderName << ENDL;
    return true;
  }
  else {
    COUT(ERROR) << "Impossible to register class builder " << builderName
        << ": a class builder with the same name is already registered." << ENDL;
    return false;
  }
}

---

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

• GGSFactory.h