libMesh::Factory< Base > Class Template Reference

Factory class definition. More...

#include <factory.h>

Inheritance diagram for libMesh::Factory< Base >:

Public Member Functions
virtual	~Factory ()=default
	Destructor.
virtual std::unique_ptr< Base >	create ()=0
	Create a Base class.

Static Public Member Functions
static std::unique_ptr< Base >	build (const std::string &name)
	Builds an object of type Base identified by name.

Protected Member Functions
	Factory (const std::string &name)
	Constructor.
std::map< std::string, Factory< FunctionBase< Number > > * > &	factory_map ()
std::map< std::string, Factory< FunctionBase< Number > > * > &	factory_map ()
std::map< std::string, Factory< Partitioner > * > &	factory_map ()

Static Protected Member Functions
static std::map< std::string, Factory< Base > * > &	factory_map ()
	Map from a name to a Factory<Base> * pointer.

Detailed Description

template<class Base>
class libMesh::Factory< Base >

Factory class definition.

Author

Benjamin S. Kirk

Date

2002

Handles name-based creation of objects.

Definition at line 46 of file factory.h.

Constructor & Destructor Documentation

Factory()

template<class Base >

libMesh::Factory< Base >::Factory ( const std::string &  name )

inlineprotected

Constructor.

Takes the name to be mapped.

Definition at line 116 of file factory.h.

{
  // Make sure we haven't already added this name
  // to the map
  libmesh_assert (!factory_map().count(name));
 
  factory_map()[name] = this;
}

References libMesh::libmesh_assert().

~Factory()

template<class Base >

virtual libMesh::Factory< Base >::~Factory ( )

virtualdefault

Destructor.

Member Function Documentation

build()

template<class Base >

std::unique_ptr< Base > libMesh::Factory< Base >::build ( const std::string &  name )

inlinestatic

Builds an object of type Base identified by name.

Definition at line 129 of file factory.h.

{
  // name not found in the map
  if (!factory_map().count(name))
    {
      libMesh::err << "Tried to build an unknown type: " << name << std::endl;
 
      libMesh::err << "valid options are:" << std::endl;
 
      for (const auto & pr : factory_map())
        libMesh::err << "  " << pr.first << std::endl;
 
      libmesh_error_msg("Exiting...");
    }
 
  Factory<Base> * f = factory_map()[name];
  return std::unique_ptr<Base>(f->create());
}

References libMesh::Factory< Base >::create(), and libMesh::err.

Referenced by main().

create()

template<class Base >

virtual std::unique_ptr< Base > libMesh::Factory< Base >::create ( )

pure virtual

Create a Base class.

Force this to be implemented later.

Implemented in libMesh::FactoryImp< Derived, Base >.

Referenced by libMesh::Factory< Base >::build().

factory_map() [1/4]

std::map< std::string, Factory< FunctionBase< Number > > * > & libMesh::Factory< FunctionBase< Number > >::factory_map ( )

protected

Definition at line 64 of file factoryfunction.C.

{
  static std::map<std::string, Factory<FunctionBase<Number>> *> _map;
  return _map;
}

factory_map() [2/4]

std::map< std::string, Factory< FunctionBase< Number > > * > & libMesh::Factory< FunctionBase< Number > >::factory_map ( )

protected

Definition at line 64 of file factoryfunction.C.

{
  static std::map<std::string, Factory<FunctionBase<Number>> *> _map;
  return _map;
}

factory_map() [3/4]

template<class Base >

static std::map< std::string, Factory< Base > * > & libMesh::Factory< Base >::factory_map ( )

staticprotected

Map from a name to a Factory<Base> * pointer.

factory_map() [4/4]

std::map< std::string, Factory< Partitioner > * > & libMesh::Factory< Partitioner >::factory_map ( )

protected

Definition at line 38 of file partitioner_factory.C.

{
  static std::map<std::string, Factory<Partitioner> *> _map;
  return _map;
}

---

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

• include/base/factory.h