EMAN::Factory< T > Class Template Reference

Factory is used to store objects to create new instances. More...

#include <emobject.h>

List of all members.

Public Types
typedef T *(*	InstanceType )()
Public Member Functions
template<>
	Factory ()
template<>
	Factory ()
template<>
	Factory ()
template<>
	Factory ()
template<>
	Factory ()
template<>
	Factory ()
template<>
	Factory ()
template<>
	Factory ()
template<>
	Factory ()
template<>
	Factory ()
template<>
	Factory ()
template<>
Symmetry3D *	get (const string &instancename)
template<>
	Factory ()
Static Public Member Functions
static void	add (InstanceType i)
static T *	get (const string &instance_name)
static T *	get (const string &instance_name, const Dict &params)
static vector< string >	get_list ()
Private Member Functions
	Factory ()
	Factory (const Factory< T > &)
	~Factory ()
void	force_add (InstanceType i)
Static Private Member Functions
static void	init ()
Private Attributes
map< string, InstanceType >	my_dict
Static Private Attributes
static Factory< T > *	my_instance = 0

---

Detailed Description

template<class T>
class EMAN::Factory< T >

Factory is used to store objects to create new instances.

It is a singleton template. Typical usages are as follows:

1. How to define a new factory (e.g. Processor Factory):

template<> Factory<Processor>::Factory() { force_add(&AbsoluateValueProcessor::NEW); force_add(&BooleanProcessor::NEW); }

2. How to use a Factory (e.g. Processor Factory):

Processor *f1 = Factory<Processor>::get("math.absvalue"); Processor *f2 = Factory<Processor>::get("eman1.filter.lowpass.gaussian", Dict("lowpass", EMObject(12));

Author:

Liwei Peng

Definition at line 700 of file emobject.h.

---

Member Typedef Documentation

template<class T>

typedef T*(* EMAN::Factory< T >::InstanceType)()

---

Constructor & Destructor Documentation

template<class T>

EMAN::Factory< T >::Factory

(

)

[private]

template<class T>

EMAN::Factory< T >::Factory

(

const Factory< T > &

)

[private]

template<class T>

EMAN::Factory< T >::~Factory

(

)

[private]

template<>

EMAN::Factory< Aligner >::Factory

(

)

[inline]

template<>

EMAN::Factory< Analyzer >::Factory

(

)

[inline]

Definition at line 51 of file analyzer.cpp.

References EMAN::SVDAnalyzer::NEW(), EMAN::KMeansAnalyzer::NEW(), EMAN::varimax::NEW(), EMAN::PCAlarge::NEW(), and EMAN::PCAsmall::NEW().

        {
                force_add(&PCAsmall::NEW);
                force_add(&PCAlarge::NEW);
                force_add(&varimax::NEW);
                force_add(&KMeansAnalyzer::NEW);
                force_add(&SVDAnalyzer::NEW);
        }

template<>

EMAN::Factory< Analyzer >::Factory

(

)

[inline]

template<>

EMAN::Factory< Averager >::Factory

(

)

[inline]

template<>

EMAN::Factory< Cmp >::Factory

(

)

[inline]

template<>

EMAN::Factory< Processor >::Factory

(

)

[inline]

template<>

EMAN::Factory< Projector >::Factory

(

)

[inline]

template<>

EMAN::Factory< Reconstructor >::Factory

(

)

[inline]

template<>

EMAN::Factory< FourierPixelInserter3D >::Factory

(

)

[inline]

template<>

EMAN::Factory< InterpolatedFRC >::Factory

(

)

[inline]

template<>

EMAN::Factory< Symmetry3D >::Factory

(

)

[inline]

template<>

EMAN::Factory< OrientationGenerator >::Factory

(

)

[inline]

---

Member Function Documentation

template<class T>

void EMAN::Factory< T >::add

(

InstanceType

i

)

[inline, static]

Definition at line 743 of file emobject.h.

        {
                init();

                T *i = new_instance();
                string name = i->get_name();
                typename map < string, InstanceType >::iterator fi =
                        my_instance->my_dict.find(name);

                if (fi == my_instance->my_dict.end()) {
                        my_instance->my_dict[name] = new_instance;
                }
                if( i )
                {
                        delete i;
                        i = 0;
                }
        }

template<class T>

T * EMAN::Factory< T >::get

(

const string &

instance_name

)

[inline, static]

Definition at line 762 of file emobject.h.

References NotExistingObjectException.

        {
                init();
                typename map < string, InstanceType >::iterator fi =
                        my_instance->my_dict.find(instancename);
                if (fi != my_instance->my_dict.end()) {
                        return my_instance->my_dict[instancename] ();
                }

                string lower = instancename;
                for (unsigned int i=0; i<lower.length(); i++) lower[i]=tolower(lower[i]);

                fi = my_instance->my_dict.find(lower);
                if (fi != my_instance->my_dict.end()) {
                        return my_instance->my_dict[lower] ();
                }

                throw NotExistingObjectException(instancename, "The named object doesn't exist");
        }

template<class T>

T * EMAN::Factory< T >::get	(	const string &	instance_name,
		const Dict &	params
	)			[inline, static]

Definition at line 782 of file emobject.h.

References InvalidParameterException, and NotExistingObjectException.

        {
                init();

                typename map < string, InstanceType >::iterator fi =
                        my_instance->my_dict.find(instancename);

                string lower = instancename;
                if (fi == my_instance->my_dict.end()) {
                        for (unsigned int i=0; i<lower.length(); i++) lower[i]=tolower(lower[i]);
                        fi = my_instance->my_dict.find(lower);
                }

                if (fi != my_instance->my_dict.end()) {
                        T *i = my_instance->my_dict[lower] ();

                        const vector<string> para_keys = params.keys();
//                      std::cout << "the number of keys is " << para_keys.size() << std::endl; // PRB May 19th
                        const vector<string> valid_keys = i->get_param_types().keys();
                        typename vector<string>::const_iterator it;
                        for(it=para_keys.begin(); it!=para_keys.end(); ++it) {
//                              std::cout << "the iterator  is " << *it << std::endl; // PRB May 19th
                                if( find(valid_keys.begin(), valid_keys.end(), *it) == valid_keys.end() ) {
                                        throw InvalidParameterException(*it);
                                }
                        }

                        i->set_params(params);
                        return i;
                }


                throw NotExistingObjectException(instancename, "No such an instance existing");
        }

template<class T>

vector< string > EMAN::Factory< T >::get_list

(

)

[inline, static]

Definition at line 818 of file emobject.h.

                                                                       {
                init();
                vector < string > result;
                typename map < string, InstanceType >::const_iterator p;
                for (p = my_instance->my_dict.begin(); p != my_instance->my_dict.end(); p++) {
                        result.push_back(p->first);
                }

                return result;
        }

template<class T>

void EMAN::Factory< T >::init

(

)

[inline, static, private]

Definition at line 723 of file emobject.h.

        {
                if (!my_instance) {
                        my_instance = new Factory < T > ();
                }
        }

template<class T>

void EMAN::Factory< T >::force_add

(

InstanceType

i

)

[inline, private]

Definition at line 730 of file emobject.h.

        {
                T *i = new_instance();
                string name = i->get_name();
                my_dict[name] = new_instance;
                if( i )
                {
                        delete i;
                        i = 0;
                }
        }

template<>

Symmetry3D * EMAN::Factory< Symmetry3D >::get

(

const string &

instancename

)

[inline]

---

Member Data Documentation

template<class T>

Factory< T > * EMAN::Factory< T >::my_instance = 0 [inline, static, private]

Definition at line 717 of file emobject.h.

template<class T>

map< string, InstanceType > EMAN::Factory< T >::my_dict [private]

Definition at line 718 of file emobject.h.

---

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

• emobject.h