EMAN::Factory< T > Class Template Reference

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

#include <emobject.h>

Public Types
typedef T *(*	InstanceType) ()

Public Member Functions
Symmetry3D *	get (const string &instancename)
	A template specialization for get - so people can call get with strings like "c1","d4" etc - this avoids have to use Dicts to specify the nsym. More...

Static Public Member Functions
template<class ClassType >
static void	add ()
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 ()
template<class ClassType >
void	force_add ()
	Factory ()
	Factory ()
	Factory ()
	Factory ()
	Factory ()
	Factory ()
	Factory ()
	Factory ()
	Factory ()
	Factory ()
	A template specialization for the Symmetry3D factory. Adds all of the symmetries. More...
	Factory ()
	Template specialization for the OrientationGenerator class. More...

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("filter.lowpass.gauss", Dict("cufoff_freq", EMObject(12));

   Author

   Liwei Peng

Definition at line 724 of file emobject.h.

Member Typedef Documentation

InstanceType

template<class T >

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

Definition at line 727 of file emobject.h.

Constructor & Destructor Documentation

Factory() [1/13]

template<class T >

EMAN::Factory< T >::Factory ( )

private

Factory() [2/13]

template<class T >

EMAN::Factory< T >::Factory ( const Factory< T > &  )

private

~Factory()

template<class T >

EMAN::Factory< T >::~Factory ( )

private

Factory() [3/13]

EMAN::Factory< Aligner >::Factory ( )

private

Factory() [4/13]

EMAN::Factory< Analyzer >::Factory ( )

private

Definition at line 55 of file analyzer.cpp.

        {
                force_add<PCAsmall>();
                force_add<PCAlarge>();
                force_add<varimax>();
                force_add<InertiaMatrixAnalyzer>();
                force_add<ShapeAnalyzer>();
                force_add<KMeansAnalyzer>();
                force_add<SVDAnalyzer>();
                force_add<CircularAverageAnalyzer>();
        }

Factory() [5/13]

EMAN::Factory< Analyzer >::Factory ( )

private

Factory() [6/13]

EMAN::Factory< Averager >::Factory ( )

private

Factory() [7/13]

EMAN::Factory< Cmp >::Factory ( )

private

Factory() [8/13]

EMAN::Factory< Processor >::Factory ( )

private

Factory() [9/13]

EMAN::Factory< Projector >::Factory ( )

private

Factory() [10/13]

EMAN::Factory< Reconstructor >::Factory ( )

private

Factory() [11/13]

EMAN::Factory< FourierPixelInserter3D >::Factory ( )

private

Factory() [12/13]

EMAN::Factory< Symmetry3D >::Factory ( )

private

A template specialization for the Symmetry3D factory. Adds all of the symmetries.

Factory() [13/13]

EMAN::Factory< OrientationGenerator >::Factory ( )

private

Template specialization for the OrientationGenerator class.

Member Function Documentation

add()

template<class T >

template<class ClassType >

void EMAN::Factory< T >::add

static

Definition at line 767 of file emobject.h.

        {
                init();
 
                string name = ClassType::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] = &ClassType::NEW;
                }
        }

force_add()

template<class T >

template<class ClassType >

void EMAN::Factory< T >::force_add

private

Definition at line 758 of file emobject.h.

        {
                string name = ClassType::NAME;
                my_dict[name] = &ClassType::NEW;
        }

get() [1/3]

template<class T >

T * EMAN::Factory< T >::get ( const string &  instance_name )

static

Definition at line 781 of file emobject.h.

        {
                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");
        }

References NotExistingObjectException.

Referenced by EMAN::dump_factory(), EMAN::dump_factory_list(), EMAN::BackProjectionReconstructor::finish(), EMAN::RealMedianReconstructor::finish(), EMAN::Transform::get_nsym(), EMAN::Transform::get_sym(), EMAN::Transform::get_sym_proj(), EMAN::Symmetry3D::get_symmetries(), EMAN::group_processors(), EMAN::FourierReconstructor::load_inserter(), EMAN::ApplySymProcessor::process(), EMAN::AutoMaskAsymUnit::process_inplace(), EMAN::SegmentSubunitProcessor::process_inplace(), EMAN::RT3DSphereAligner::xform_align_nbest(), EMAN::RT2Dto3DTreeAligner::xform_align_nbest(), EMAN::RT3DTreeAligner::xform_align_nbest(), and EMAN::RT3DLocalTreeAligner::xform_align_nbest().

get() [2/3]

template<class T >

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

static

Definition at line 802 of file emobject.h.

        {
                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();
                        for(auto 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");
        }

References InvalidParameterException, EMAN::Dict::keys(), and NotExistingObjectException.

get() [3/3]

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

(

const string &

instancename

)

A template specialization for get - so people can call get with strings like "c1","d4" etc - this avoids have to use Dicts to specify the nsym.

get_list()

template<class T >

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

static

Definition at line 837 of file emobject.h.

                                            {
                init();
                vector<string> result;
                for (auto p = my_instance->my_dict.begin(); p != my_instance->my_dict.end(); p++) {
                        result.push_back(p->first);
                }
 
                return result;
        }

Referenced by EMAN::dump_factory(), EMAN::dump_factory_list(), and EMAN::group_processors().

init()

template<class T >

void EMAN::Factory< T >::init

staticprivate

Definition at line 749 of file emobject.h.

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

Member Data Documentation

my_dict

template<class T >

map<string, InstanceType> EMAN::Factory< T >::my_dict

private

Definition at line 742 of file emobject.h.

my_instance

template<class T >

Factory< T > * EMAN::Factory< T >::my_instance = 0

staticprivate

Definition at line 741 of file emobject.h.

---

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

• emobject.h