QUESO::Factory< Base > Class Template Reference

#include <Factory.h>

Inheritance diagram for QUESO::Factory< Base >:

Public Member Functions
virtual	~Factory ()
virtual SharedPtr< Base >::Type	create ()=0

Static Public Member Functions
static SharedPtr< Base >::Type	build (const std::string &name)

Protected Member Functions
	Factory (const std::string &name)
template<>
std::map< std::string, Factory < Algorithm< GslVector, GslMatrix > > * > &	factory_map ()
template<>
std::map< std::string, Factory < BaseTKGroup< GslVector, GslMatrix > > * > &	factory_map ()

Static Protected Member Functions
static std::map< std::string, Factory< Base > * > &	factory_map ()

Detailed Description

template<class Base>
class QUESO::Factory< Base >

Factory class defintion.

Definition at line 43 of file Factory.h.

Constructor & Destructor Documentation

template<class Base >

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

inlineprotected

Constructor. Takes the name to be mapped.

Definition at line 103 of file Factory.h.

References queso_assert.

{
  // Make sure we haven't already added this name
  // to the map
  queso_assert(!factory_map().count(name));

  factory_map()[name] = this;
}

template<class Base>

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

inlinevirtual

Destructor. (Empty.)

Definition at line 55 of file Factory.h.

{}

Member Function Documentation

template<class Base >

SharedPtr< Base >::Type QUESO::Factory< Base >::build ( const std::string &  name )

inlinestatic

Builds an object of type Base identified by name.

Definition at line 114 of file Factory.h.

References QUESO::Factory< Base >::create(), it, and queso_error_msg.

{
  // name not found in the map
  if (!factory_map().count(name))
    {
      std::cerr << "Tried to build an unknown type: " << name << std::endl;

      std::cerr << "valid options are:" << std::endl;

      for (typename std::map<std::string,Factory<Base> *>::const_iterator
             it = factory_map().begin(); it != factory_map().end(); ++it)
        std::cerr << "  " << it->first << std::endl;

      queso_error_msg("Exiting...");

      // We'll never get here
      return typename SharedPtr<Base>::Type();
    }

  Factory<Base> * f = factory_map()[name];
  return typename SharedPtr<Base>::Type(f->create());
}

template<class Base>

virtual SharedPtr<Base>::Type QUESO::Factory< Base >::create ( )

pure virtual

Create a Base class. Force this to be implemented later.

Implemented in QUESO::TransitionKernelFactory, QUESO::FactoryImp< Derived, Base >, and QUESO::AlgorithmFactory.

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

template<>

std::map< std::string, Factory< Algorithm< GslVector, GslMatrix > > * > & QUESO::Factory< Algorithm< GslVector, GslMatrix > >::factory_map ( )

protected

Definition at line 34 of file AlgorithmFactory.C.

{
  static std::map<std::string, Factory<Algorithm<GslVector, GslMatrix> > *> _factory_map;

  return _factory_map;
}

template<>

std::map< std::string, Factory< BaseTKGroup< GslVector, GslMatrix > > * > & QUESO::Factory< BaseTKGroup< GslVector, GslMatrix > >::factory_map ( )

protected

Definition at line 37 of file TransitionKernelFactory.C.

{
  static std::map<std::string, Factory<BaseTKGroup<GslVector, GslMatrix> > *> _factory_map;

  return _factory_map;
}

template<class Base>

static std::map<std::string, Factory<Base> *>& QUESO::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:

• src/core/inc/Factory.h