Factory class to create Func1 objects. More...

#include <Func1Factory.h>

Inheritance diagram for Func1Factory:

[legend]

Detailed Description

Factory class to create Func1 objects.

This class is mainly used via the newFunc1() function, for example:

shared_ptr<Func1> d1 = newFunc1("sin", {1.0});

Cantera::newFunc1

shared_ptr< Func1 > newFunc1(const string &func1Type, double coeff)

Create a new simple functor object (see Simple Functors).

Definition Func1Factory.cpp:145

Since: New in Cantera 3.0

Definition at line 23 of file Func1Factory.h.

Public Member Functions
void	deleteFactory () override
	Virtual abstract function that deletes the factory.

Public Member Functions inherited from Factory< Func1, const vector< double > & >
Func1 *	create (const string &name, Args... args)
	Create an object using the object construction function corresponding to "name" and the provided constructor arguments.

void	reg (const string &name, function< Func1 *(Args...)> f)
	Register a new object construction function.

void	addAlias (const string &original, const string &alias)
	Add an alias for an existing registered type.

string	canonicalize (const string &name)
	Get the canonical name registered for a type.

bool	exists (const string &name) const
	Returns true if `name` is registered with this factory.

Public Member Functions inherited from FactoryBase
virtual	~FactoryBase ()
	destructor

Static Public Member Functions
static Func1Factory *	factory ()
	Return a pointer to the factory.

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

Private Member Functions
	Func1Factory ()
	default constructor, which is defined as private

Static Private Attributes
static Func1Factory *	s_factory = 0
	Pointer to the single instance of the factory.

static std::mutex	s_mutex
	Mutex for use when calling the factory.

Additional Inherited Members
Protected Member Functions inherited from Factory< Func1, const vector< double > & >
void	addDeprecatedAlias (const string &original, const string &alias)
	Add a deprecated alias for an existing registered type.

Protected Member Functions inherited from FactoryBase
	FactoryBase ()
	Constructor.

virtual void	deleteFactory ()=0
	Virtual abstract function that deletes the factory.

Constructor & Destructor Documentation

◆ Func1Factory()

Func1Factory ( )

private

default constructor, which is defined as private

Definition at line 14 of file Func1Factory.cpp.

Member Function Documentation

◆ factory()

Func1Factory * 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 59 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 68 of file Func1Factory.cpp.

Member Data Documentation

◆ s_factory

Func1Factory * s_factory = 0

staticprivate

Pointer to the single instance of the factory.

Definition at line 37 of file Func1Factory.h.

◆ s_mutex

std::mutex s_mutex

staticprivate

Mutex for use when calling the factory.

Definition at line 43 of file Func1Factory.h.

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

Detailed Description

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Attributes

Additional Inherited Members