VQwFactory< base_t > Class Template Reference

Pure virtual factory. More...

#include <QwFactory.h>

Inheritance diagram for VQwFactory< base_t >:

Public Member Functions
virtual	~VQwFactory ()
	Default virtual destructor. More...
virtual base_t *	Create (const std::string &name) const =0
	Creation of objects by type (pure virtual) More...
virtual base_t *	Cast (base_t *base) const =0
	Dynamic cast to type (pure virtual) More...

Static Public Member Functions
static base_t *	Create (const std::string &type, const std::string &name)
	Create an object of type with name. More...
static base_t *	Cast (base_t *base, const std::string &type)
	Dynamic cast of object into type. More...
static bool	InheritsFrom (base_t *base, const std::string &type)
	Test whether object inherits from type. More...

Static Protected Member Functions
static std::map< std::string, VQwFactory * > &	GetRegisteredTypes ()
	Map from string to concrete type factories. More...
static void	ListRegisteredTypes ()
	List available type factories. More...
static VQwFactory *	GetFactory (const std::string &type)
	Get a concrete type factory by string. More...

Detailed Description

template<class base_t>
class VQwFactory< base_t >

Pure virtual factory.

In order to enable the instantiation of types based on run-time information, we generate a map of type factories by type name. This map is filled automatically when the executable is loaded, and contains concrete factories derived from this pure virtual base class.

Definition at line 33 of file QwFactory.h.

Constructor & Destructor Documentation

template<class base_t>

virtual VQwFactory< base_t >::~VQwFactory ( )

inlinevirtual

Default virtual destructor.

Definition at line 38 of file QwFactory.h.

{ }

Member Function Documentation

template<class base_t>

static base_t* VQwFactory< base_t >::Cast ( base_t *  base, const std::string &  type  )

inlinestatic

Dynamic cast of object into type.

Definition at line 46 of file QwFactory.h.

Referenced by VQwFactory< VQwDataElement >::Cast(), and VQwFactory< VQwDataElement >::InheritsFrom().

                                                             {
      return GetFactory(type)->Cast(base);
    }

Here is the caller graph for this function:

template<class base_t>

virtual base_t* VQwFactory< base_t >::Cast ( base_t *  base ) const

pure virtual

Dynamic cast to type (pure virtual)

Implemented in QwFactory< base_t, type_t >, QwFactory< VQwDataElement, dataelement_t >, and QwFactory< VQwSubsystem, subsystem_t >.

template<class base_t>

static base_t* VQwFactory< base_t >::Create ( const std::string &  type, const std::string &  name  )

inlinestatic

Create an object of type with name.

Definition at line 41 of file QwFactory.h.

Referenced by VQwFactory< VQwDataElement >::Create().

                                                                        {
      return GetFactory(type)->Create(name);
    }

Here is the caller graph for this function:

template<class base_t>

virtual base_t* VQwFactory< base_t >::Create ( const std::string &  name ) const

pure virtual

Creation of objects by type (pure virtual)

Implemented in QwFactory< base_t, type_t >, QwFactory< VQwDataElement, dataelement_t >, and QwFactory< VQwSubsystem, subsystem_t >.

template<class base_t>

static VQwFactory* VQwFactory< base_t >::GetFactory ( const std::string &  type )

inlinestaticprotected

Get a concrete type factory by string.

Definition at line 76 of file QwFactory.h.

Referenced by VQwFactory< VQwDataElement >::Cast(), and VQwFactory< VQwDataElement >::Create().

                                                         {
      if (GetRegisteredTypes().find(type) != GetRegisteredTypes().end())
        return GetRegisteredTypes()[type];
      else {
        QwError << "Type " << type << " is not registered!" << QwLog::endl;
        QwMessage << "Available types:" << QwLog::endl;
        ListRegisteredTypes();
        QwWarning << "To register this type, add the following line to the top "
                  << "of the source file:" << QwLog::endl;
        QwWarning << "  RegisterSomethingFactory(" << type << ");" << QwLog::endl;
        QwWarning << "Ensure that the dynamic library contains the factory object."
                  << QwLog::endl;
        throw QwException_TypeUnknown();
      }
    }

Here is the caller graph for this function:

template<class base_t>

static std::map<std::string,VQwFactory*>& VQwFactory< base_t >::GetRegisteredTypes ( )

inlinestaticprotected

Map from string to concrete type factories.

Definition at line 63 of file QwFactory.h.

Referenced by VQwFactory< VQwDataElement >::GetFactory(), VQwFactory< VQwDataElement >::ListRegisteredTypes(), and QwFactory< VQwSubsystem, subsystem_t >::QwFactory().

                                                               {
      static std::map<std::string,VQwFactory<base_t>*> theMap;
      return theMap;
    }

Here is the caller graph for this function:

template<class base_t>

static bool VQwFactory< base_t >::InheritsFrom ( base_t *  base, const std::string &  type  )

inlinestatic

Test whether object inherits from type.

Definition at line 51 of file QwFactory.h.

                                                                  {
      return (Cast(base,type) != 0);
    }

template<class base_t>

static void VQwFactory< base_t >::ListRegisteredTypes ( )

inlinestaticprotected

List available type factories.

Definition at line 68 of file QwFactory.h.

Referenced by VQwFactory< VQwDataElement >::GetFactory().

                                      {
      typename std::map<std::string,VQwFactory<base_t>*>::iterator type;
      for (type = GetRegisteredTypes().begin();
           type != GetRegisteredTypes().end(); type++ )
        QwMessage << type->first << QwLog::endl;
    }

Here is the caller graph for this function:

---

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

• QwFactory.h