Cantera  3.1.0a1
Math1FactoryB Class Reference

Factory class to create Func1 compound objects - version B. More...

#include <Func1Factory.h>

Inheritance diagram for Math1FactoryB:
[legend]

Detailed Description

Factory class to create Func1 compound objects - version B.

This class is mainly used via the newFunc1(const string&, const shared_ptr<Func1>, double) function, for example:

shared_ptr<Func1> d1 = newFunc1("plus-constant", f, 1.);
shared_ptr< Func1 > newFunc1(const string &func1Type, double coeff)
Create a new simple functor object (see Simple Functors).
Since
New in Cantera 3.0

Definition at line 90 of file Func1Factory.h.

Public Member Functions

void deleteFactory () override
 Virtual abstract function that deletes the factory. More...
 
- Public Member Functions inherited from Factory< Func1, const shared_ptr< Func1 >, double >
Func1create (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< Func1 *(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...
 

Static Public Member Functions

static Math1FactoryBfactory ()
 Return a pointer to the factory. More...
 
- 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...
 

Private Member Functions

 Math1FactoryB ()
 default constructor, which is defined as private More...
 

Static Private Attributes

static Math1FactoryBs_factory = 0
 Pointer to the single instance of the factory. More...
 
static std::mutex s_mutex
 Mutex for use when calling the factory. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Factory< Func1, const shared_ptr< Func1 >, double >
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...
 

Constructor & Destructor Documentation

◆ Math1FactoryB()

Math1FactoryB ( )
private

default constructor, which is defined as private

Definition at line 116 of file Func1Factory.cpp.

Member Function Documentation

◆ factory()

Math1FactoryB * factory ( )
static

Return a pointer to the factory.

On the first call, a new instance is created. Since there is no need to instantiate more than one factory, on all subsequent calls, a pointer to the existing factory is returned.

Definition at line 129 of file Func1Factory.cpp.

◆ deleteFactory()

void deleteFactory ( )
overridevirtual

Virtual abstract function that deletes the factory.

This must be properly defined in child objects.

Implements FactoryBase.

Definition at line 138 of file Func1Factory.cpp.

Member Data Documentation

◆ s_factory

Math1FactoryB * s_factory = 0
staticprivate

Pointer to the single instance of the factory.

Definition at line 104 of file Func1Factory.h.

◆ s_mutex

std::mutex s_mutex
staticprivate

Mutex for use when calling the factory.

Definition at line 110 of file Func1Factory.h.


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