Detailed Description

Factory for kinetics managers.

Definition at line 21 of file KineticsFactory.h.

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

Kinetics *	newKinetics (const string &model)
	Return a new, empty kinetics manager.

Public Member Functions inherited from Factory< Kinetics >
Kinetics *	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< Kinetics *(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 KineticsFactory *	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

Static Private Attributes
static KineticsFactory *	s_factory = 0

static std::mutex	kinetics_mutex

Additional Inherited Members
Protected Member Functions inherited from Factory< Kinetics >
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

◆ KineticsFactory()

KineticsFactory ( )

private

Definition at line 24 of file KineticsFactory.cpp.

Member Function Documentation

◆ factory()

KineticsFactory * factory ( )

static

Definition at line 40 of file KineticsFactory.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 48 of file KineticsFactory.cpp.

◆ newKinetics()

Kinetics * newKinetics ( const string & model )

Return a new, empty kinetics manager.

Definition at line 54 of file KineticsFactory.cpp.

Member Data Documentation

◆ s_factory

KineticsFactory * s_factory = 0

staticprivate

Definition at line 34 of file KineticsFactory.h.

◆ kinetics_mutex

std::mutex kinetics_mutex

staticprivate

Definition at line 36 of file KineticsFactory.h.

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

KineticsFactory Class Reference#