Cantera
3.1.0a1
|
Factory class that supports registering functions to create objects. More...
#include <FactoryBase.h>
Factory class that supports registering functions to create objects.
Template arguments for the class are the base type created by the factory, followed by the types of any arguments which need to be passed to the functions used to create objects, that is, arguments to the constructor.
Definition at line 69 of file FactoryBase.h.
Public Member Functions | |
T * | create (const string &name, Args... args) |
Create an object using the object construction function corresponding to "name" and the provided constructor arguments. More... | |
void | reg (const string &name, function< T *(Args...)> f) |
Register a new object construction function. More... | |
void | addAlias (const string &original, const string &alias) |
Add an alias for an existing registered type. More... | |
string | canonicalize (const string &name) |
Get the canonical name registered for a type. More... | |
bool | exists (const string &name) const |
Returns true if name is registered with this factory. More... | |
Public Member Functions inherited from FactoryBase | |
virtual | ~FactoryBase () |
destructor More... | |
Protected Member Functions | |
void | addDeprecatedAlias (const string &original, const string &alias) |
Add a deprecated alias for an existing registered type. More... | |
Protected Member Functions inherited from FactoryBase | |
FactoryBase () | |
Constructor. More... | |
virtual void | deleteFactory ()=0 |
Virtual abstract function that deletes the factory. More... | |
Private Attributes | |
std::unordered_map< string, function< T *(Args...)> > | m_creators |
std::unordered_map< string, string > | m_synonyms |
Map of synonyms to canonical names. More... | |
std::unordered_map< string, string > | m_deprecated_names |
Map of deprecated synonyms to canonical names. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from FactoryBase | |
static void | deleteFactories () |
static function that deletes all factories in the internal registry maintained in a static variable More... | |
|
inline |
Create an object using the object construction function corresponding to "name" and the provided constructor arguments.
Definition at line 75 of file FactoryBase.h.
|
inline |
Register a new object construction function.
Definition at line 80 of file FactoryBase.h.
|
inline |
Add an alias for an existing registered type.
Definition at line 85 of file FactoryBase.h.
|
inline |
Get the canonical name registered for a type.
Definition at line 94 of file FactoryBase.h.
|
inline |
Returns true if name
is registered with this factory.
Definition at line 110 of file FactoryBase.h.
|
inlineprotected |
Add a deprecated alias for an existing registered type.
Definition at line 116 of file FactoryBase.h.
|
private |
Map of synonyms to canonical names.
Definition at line 129 of file FactoryBase.h.
|
private |
Map of deprecated synonyms to canonical names.
Use of these names will show a deprecation warning.
Definition at line 133 of file FactoryBase.h.