Factory class for instantiating algorithm instance by larcv::ImageClusterManager This factory class can instantiate a specified algorithm instance w/ provided instance name. More...

#include <ImageClusterFactory.h>

Inheritance diagram for larcv::ImageClusterFactory:

Public Member Functions
	ImageClusterFactory ()
	Default ctor, shouldn't be used. More...

	~ImageClusterFactory ()
	Default dtor. More...

void	add_factory (const std::string name, larcv::ImageClusterFactoryBase *factory)
	Factory registration method (should be called by global factory instance in algorithm header) More...

ImageClusterBase *	create (const std::string name, const std::string instance_name)
	Factory creation method (should be called by clients, possibly you!) More...

const larcv::logger &	logger () const
	Logger getter. More...

void	set_verbosity (::larcv::msg::Level_t level)
	Verbosity level. More...

Static Public Member Functions
static ImageClusterFactory &	get ()
	Static sharable instance getter. More...

Private Attributes
std::map< std::string, larcv::ImageClusterFactoryBase * >	_factory_map
	Static factory container. More...

Static Private Attributes
static ImageClusterFactory *	_me = nullptr
	Static self. More...

Detailed Description

Factory class for instantiating algorithm instance by larcv::ImageClusterManager This factory class can instantiate a specified algorithm instance w/ provided instance name.

The actual factory core (to which each algorithm must register creation factory instance) is
a static std::map. Use static method to get a static instance (larcv::ImageClusterFactory::get)
to access a factory.

Definition at line 47 of file ImageClusterFactory.h.

Constructor & Destructor Documentation

larcv::ImageClusterFactory::ImageClusterFactory ( )

inline

Default ctor, shouldn't be used.

Definition at line 51 of file ImageClusterFactory.h.

References LARCV_WARNING.

Referenced by get().

51 : laropencv_base("ImageClusterFactory")

52 {LARCV_WARNING((*this)) << "To have a factory access static object via ImageClusterFactory::get()!" << std::endl;}

larcv::ImageClusterFactory::~ImageClusterFactory ( )

inline

Default dtor.

Definition at line 54 of file ImageClusterFactory.h.

References _factory_map.

54 {_factory_map.clear();}

Member Function Documentation

void larcv::ImageClusterFactory::add_factory	(	const std::string	name,
		larcv::ImageClusterFactoryBase *	factory
	)

inline

Factory registration method (should be called by global factory instance in algorithm header)

Definition at line 59 of file ImageClusterFactory.h.

References _factory_map.

Referenced by larcv::EmptyImageClusterFactory::EmptyImageClusterFactory(), larcv::SBClusterFactory::SBClusterFactory(), and larcv::ToyImageClusterFactory::ToyImageClusterFactory().

60 { _factory_map[name] = factory; }

ImageClusterBase* larcv::ImageClusterFactory::create	(	const std::string	name,
		const std::string	instance_name
	)

inline

Factory creation method (should be called by clients, possibly you!)

Definition at line 62 of file ImageClusterFactory.h.

References _factory_map, and LARCV_ERROR.

                                                                                   {
       auto iter = _factory_map.find(name);
       if(iter == _factory_map.end() || !((*iter).second)) {
     LARCV_ERROR((*this)) << "Found no registered class " << name << std::endl;
     return nullptr;
       }
       return (*iter).second->create(instance_name);
     }