libMesh::Factory< Base > Class Template Referenceabstract

#include <factory.h>

Inheritance diagram for libMesh::Factory< Base >:

Public Member Functions

virtual ~Factory ()
 
virtual AutoPtr< Base > create ()=0
 

Static Public Member Functions

static AutoPtr< Base > build (const std::string &name)
 

Protected Member Functions

 Factory (const std::string &name)
 
template<>
std::map< std::string, Factory
< Partitioner > * > & 
factory_map ()
 

Static Protected Member Functions

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

Detailed Description

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

Factory class defintion.

Definition at line 42 of file factory.h.

Constructor & Destructor Documentation

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

Constructor. Takes the name to be mapped.

Definition at line 113 of file factory.h.

References libMesh::libmesh_assert(), and libMesh::Quality::name().

114 {
115  // Make sure we haven't already added this name
116  // to the map
117  libmesh_assert (!factory_map().count(name));
118 
119  factory_map()[name] = this;
120 }
template<class Base>
virtual libMesh::Factory< Base >::~Factory ( )
inlinevirtual

Destructor. (Empty.)

Definition at line 56 of file factory.h.

56 {}

Member Function Documentation

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

Builds an object of type Base identified by name.

Definition at line 126 of file factory.h.

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

127 {
128  // name not found in the map
129  if (!factory_map().count(name))
130  {
131  libMesh::err << "Tried to build an unknown type: " << name << std::endl;
132 
133  libMesh::err << "valid options are:" << std::endl;
134 
135  for (typename std::map<std::string,Factory<Base>*>::const_iterator
136  it = factory_map().begin(); it != factory_map().end(); ++it)
137  libMesh::err << " " << it->first << std::endl;
138 
139  libmesh_error();
140 
141  // Do this the stoopid way for IBM xlC
142  AutoPtr<Base> ret_val (NULL);
143 
144  return ret_val;
145  }
146 
147  // Do this the stoopid way for IBM xlC
148  Factory<Base> *f = factory_map()[name];
149 
150  AutoPtr<Base> ret_val (f->create());
151 
152  return ret_val;
153 }
template<class Base>
virtual AutoPtr<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().

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

Definition at line 40 of file partitioner_factory.C.

41 {
42  static std::map<std::string, Factory<Partitioner>*> _map;
43  return _map;
44 }
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.


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

Site Created By: libMesh Developers
Last modified: February 07 2014 16:58:00 UTC

Hosted By:
SourceForge.net Logo