Cantera  3.1.0a1
Loading...
Searching...
No Matches
WallFactory Class Reference

Factory class to create WallBase objects. More...

#include <WallFactory.h>

Inheritance diagram for WallFactory:
[legend]

Detailed Description

Factory class to create WallBase objects.

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

shared_ptr<WallBase> piston = newWall("Wall");
shared_ptr< WallBase > newWall(const string &model)
Create a WallBase object of the specified type.

Definition at line 22 of file WallFactory.h.

Public Member Functions

void deleteFactory () override
 Virtual abstract function that deletes the factory.
 
- Public Member Functions inherited from Factory< WallBase >
WallBasecreate (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< WallBase *(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 WallFactoryfactory ()
 
- 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 WallFactorys_factory = 0
 
static std::mutex wall_mutex
 

Additional Inherited Members

- Protected Member Functions inherited from Factory< WallBase >
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

◆ WallFactory()

WallFactory ( )
private

Definition at line 15 of file WallFactory.cpp.

Member Function Documentation

◆ factory()

WallFactory * factory ( )
static

Definition at line 20 of file WallFactory.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 28 of file WallFactory.cpp.

Member Data Documentation

◆ s_factory

WallFactory * s_factory = 0
staticprivate

Definition at line 30 of file WallFactory.h.

◆ wall_mutex

std::mutex wall_mutex
staticprivate

Definition at line 31 of file WallFactory.h.


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