libMesh
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
libMesh::Factory< Base > Class Template Referenceabstract

Factory class definition. More...

#include <factory.h>

Inheritance diagram for libMesh::Factory< Base >:
[legend]

Public Member Functions

virtual ~Factory ()
 Destructor. More...
 
virtual UniquePtr< Base > create ()=0
 Create a Base class. More...
 

Static Public Member Functions

static UniquePtr< Base > build (const std::string &name)
 Builds an object of type Base identified by name. More...
 

Protected Member Functions

 Factory (const std::string &name)
 Constructor. More...
 
template<>
std::map< std::string, Factory< FunctionBase< Number > > * > & factory_map ()
 
template<>
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. More...
 

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

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

Constructor.

Takes the name to be mapped.

Definition at line 116 of file factory.h.

References libMesh::Factory< Base >::factory_map(), libMesh::libmesh_assert(), and libMesh::Quality::name().

117 {
118  // Make sure we haven't already added this name
119  // to the map
120  libmesh_assert (!factory_map().count(name));
121 
122  factory_map()[name] = this;
123 }
std::string name(const ElemQuality q)
This function returns a string containing some name for q.
Definition: elem_quality.C:39
static std::map< std::string, Factory< Base > * > & factory_map()
Map from a name to a Factory<Base> * pointer.
libmesh_assert(j)
template<class Base >
virtual libMesh::Factory< Base >::~Factory ( )
virtual

Destructor.

(Empty.)

Definition at line 60 of file factory.h.

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

60 {}

Member Function Documentation

template<class Base >
UniquePtr< Base > libMesh::Factory< Base >::build ( const std::string &  name)
static

Builds an object of type Base identified by name.

Definition at line 129 of file factory.h.

References libMesh::err, libMesh::Factory< Base >::factory_map(), and libMesh::Quality::name().

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

130 {
131  // name not found in the map
132  if (!factory_map().count(name))
133  {
134  libMesh::err << "Tried to build an unknown type: " << name << std::endl;
135 
136  libMesh::err << "valid options are:" << std::endl;
137 
138  for (typename std::map<std::string,Factory<Base> *>::const_iterator
139  it = factory_map().begin(); it != factory_map().end(); ++it)
140  libMesh::err << " " << it->first << std::endl;
141 
142  libmesh_error_msg("Exiting...");
143 
144  // We'll never get here
145  return UniquePtr<Base>();
146  }
147 
148  Factory<Base> * f = factory_map()[name];
149  return UniquePtr<Base>(f->create());
150 }
std::string name(const ElemQuality q)
This function returns a string containing some name for q.
Definition: elem_quality.C:39
OStreamProxy err
static std::map< std::string, Factory< Base > * > & factory_map()
Map from a name to a Factory<Base> * pointer.
template<class Base >
virtual UniquePtr<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 >::~Factory(), and libMesh::FactoryImp< Derived, Base >::~FactoryImp().

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

Definition at line 38 of file partitioner_factory.C.

39 {
40  static std::map<std::string, Factory<Partitioner> *> _map;
41  return _map;
42 }
template<>
std::map< std::string, Factory< FunctionBase< Number > > * > & libMesh::Factory< FunctionBase< Number > >::factory_map ( )
protected

Definition at line 62 of file factoryfunction.C.

References libMesh::example_one_factory.

63 {
64  static std::map<std::string, Factory<FunctionBase<Number>> *> _map;
65  return _map;
66 }
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.

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


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