CreatorManager Class Reference

Class to manage all creators and provide factory access. More...

#include <CreatorManager.h>

Collaboration diagram for CreatorManager:

Public Types
typedef CreatorBase *	CreatorFactory()
	Typedef for a factory function.

Static Public Member Functions
static void	registerCreatorFactory (const std::string &name, CreatorFactory *factory)
	Register a new creator by providing a name and a pointer to a factory for this kind of creator.
static CreatorBase *	getCreator (const std::string &name, const std::string &library="")
	Return a new instance of a creator with the given name.

Protected Member Functions
	CreatorManager ()
	singleton, hide constructor
	CreatorManager (const CreatorManager &)=delete
	singleton, hide copy constructor
void	operator= (const CreatorManager &)=delete
	singleton, hide assignment operator

Static Protected Member Functions
static CreatorManager &	getInstance ()
	getter for the singleton instance

Protected Attributes
std::map< std::string, CreatorFactory * >	m_creatorFactories
	Static map to hold all registered factories.

Detailed Description

Class to manage all creators and provide factory access.

Definition at line 24 of file CreatorManager.h.

Member Typedef Documentation

CreatorFactory

typedef CreatorBase * CreatorFactory()

Typedef for a factory function.

Definition at line 27 of file CreatorManager.h.

Constructor & Destructor Documentation

CreatorManager()

CreatorManager ( )

inlineprotected

singleton, hide constructor

Definition at line 55 of file CreatorManager.h.

{}

Member Function Documentation

getCreator()

CreatorBase * getCreator ( const std::string &  name, const std::string &  library = ""  )

static

Return a new instance of a creator with the given name.

If library is not empty, the specified library will be loaded before attempting to create the creator to allow for on-demand loading of libraries.

Returns 0 if no creator with the given name is registered. Ownership of the creator is transferred to the caller who is responsible of freeing the creator.

Parameters

name	Name of the Creator to be created
library	Short name of the library which should be loaded before trying to create the creator. When library is "foo", libfoo.so will be loaded

Definition at line 31 of file CreatorManager.cc.

{
  if (!library.empty()) {
    FileSystem::loadLibrary(library, false);
  }
 
  CreatorManager& instance = getInstance();
  auto it = instance.m_creatorFactories.find(name);
  if (it == instance.m_creatorFactories.end()) {
    B2ERROR("Could not find a geometry creator named " << name);
    return nullptr;
  }
  return it->second();
}

getInstance()

CreatorManager & getInstance ( )

staticprotected

getter for the singleton instance

Definition at line 18 of file CreatorManager.cc.

{
  static unique_ptr<CreatorManager> instance(new CreatorManager());
  return *instance;
}

registerCreatorFactory()

void registerCreatorFactory ( const std::string &  name, CreatorFactory *  factory  )

static

Register a new creator by providing a name and a pointer to a factory for this kind of creator.

Parameters

name	Name of the creator to be registered
factory	Pointer to a function returning new instances of the creator

Definition at line 26 of file CreatorManager.cc.

{
  getInstance().m_creatorFactories[name] = factory;
}

Member Data Documentation

m_creatorFactories

std::map<std::string, CreatorFactory*> m_creatorFactories

protected

Static map to hold all registered factories.

Definition at line 63 of file CreatorManager.h.

---

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

• geometry/include/CreatorManager.h
• geometry/src/CreatorManager.cc