CLAM::Factory< AbstractProductType > Class Template Reference

#include <Factory.hxx>

Classes
class	Creator
	Abstract class for Creator objects which are stored in the Factory::Registry. More...
struct	Pair
class	Registry
	This class is an implementation class of the Factory. More...
Public Types
typedef AbstractProductType	AbstractProduct
typedef std::string	RegistryKey
typedef std::list< Key >	Keys
typedef std::list< std::string >	Values
typedef std::list< Pair >	Pairs
Public Member Functions
	Factory ()
	~Factory ()
AbstractProduct *	Create (const RegistryKey name)
	Gives ownership of the new created Product registered with the given name.
AbstractProduct *	CreateSafe (const RegistryKey name) throw (ErrFactory)
	Gives ownership of the new created Product registered with the given name.
void	Clear ()
void	AddCreator (const RegistryKey name, Creator *creator)
void	AddCreatorWarningRepetitions (const RegistryKey name, Creator *creator)
void	AddCreatorSafe (const RegistryKey name, Creator *creator) throw (ErrFactory)
void	DeleteCreator (const RegistryKey name)
void	GetRegisteredNames (std::list< std::string > &namesList)
bool	KeyExists (const RegistryKey &key)
bool	AttributeExists (const std::string &key, const std::string &attribute)
Keys	GetKeys (const std::string &attribute, const std::string &value)
	Get all keys that have attribute==value in its metadata.
Keys	GetKeys ()
	Get all keys in the factory.
Pairs	GetPairsFromKey (const std::string &key)
	Return all the metadata available for a product key.
Values	GetSetOfValues (const std::string &attribute)
	Get the set of all values present for a given metadata attribute. Example GetSetOfValues("category") could return ["modulators","generators","reverbs"] without repeated items.
Values	GetValuesFromAttribute (const std::string &key, const std::string &attribute)
	Return the list of values for a metadata attribute for a product key.
Value	GetValueFromAttribute (const std::string &key, const std::string &attribute)
	Return the value for a metadata attribute of product key. If multiple values exist returns the first value.
void	AddAttribute (const std::string &key, const std::string &attribute, const std::string &value)
int	Count ()

Detailed Description

template<typename AbstractProductType>
class CLAM::Factory< AbstractProductType >

Factory usage example.

To define a factory for your types you should create your own factory subclass.

// MyFactory.hxx
class MyFactory : public CLAM::Factory<MyAbstractProduct>
{
public:
        static MyFactory& GetInstance();
};

You must define GetInstance() method in a .cxx

// MyFactory.cxx
#include "MyFactory.hxx"
MyFactory& MyFactory::GetInstance()
{       
        static MyFactory theInstance;
        return theInstance;
}

To automatically register concrete products into the factory at program loading time (before "main()" starts), declare a registrator object like this:

// put this in a .cxx (not in a header)
static CLAM::FactoryRegistrator<MyFactory, MyConcreteProduct> regMyConcreteProduct("MyConcreteProduct");

Definition at line 68 of file Factory.hxx.