Pluggable factory. More...

#include <Factory.hh>

Public Types
typedef P	Product

typedef Product::FactoryKey	Key

typedef Product::FactoryKeyP	KeyP

typedef Product::FactoryKeyFxn	KeyFxn

typedef Product::FactoryProductP	ProductP

typedef Product::FactoryArg	Arg

typedef Product::FactoryCreate	Create

Static Public Member Functions
static void	add (Key const &key, Create create)
	Add a Product to the registry. More...

static void	add (KeyP const &key_p, Create create)
	Add a Product to the pointer registry. More...

static void	add (KeyFxn key_fxn, Create create)
	Add a Product to the function registry. More...

static void	remove (Key const &key)
	Remove a Product from the registry. More...

static void	remove (KeyP const &key_p)
	Remove a Product from the pointer registry. More...

static void	remove (KeyFxn key_fxn)
	Remove a Product from the function registry. More...

static bool	has (Key const &key)
	Has a Product with key? More...

static ProductP	create (Key const &key)
	Create a Product from key. More...

static ProductP	create (Key const &key, Arg &arg)
	Create a Product from key and 1 argument. More...

Private Types
typedef std::map< Key, Create >	Registry

typedef std::map< KeyP, Create >	PtrRegistry

typedef std::map< KeyFxn, Create >	FxnRegistry

Private Member Functions
	Factory ()=default
	Default constructor. More...

Static Private Member Functions
static Registry &	registry ()
	Key registry. More...

static PtrRegistry &	ptr_registry ()
	Key pointer registry. More...

static FxnRegistry &	fxn_registry ()
	Key function registry. More...

static void	ptr_registry_transfer (Registry &reg)
	Transfer key pointer registry to key registry. More...

static void	fxn_registry_transfer (Registry &reg)
	Transfer key function registry to key registry. More...

Detailed Description

template<typename P>
class utility::factory::Factory

Pluggable factory.

Member Typedef Documentation

◆ Arg

template<typename P >

typedef Product::FactoryArg utility::factory::Factory::Arg

◆ Create

template<typename P >

typedef Product::FactoryCreate utility::factory::Factory::Create

◆ FxnRegistry

template<typename P >

typedef std::map< KeyFxn, Create > utility::factory::Factory::FxnRegistry

private

◆ Key

template<typename P >

typedef Product::FactoryKey utility::factory::Factory::Key

◆ KeyFxn

template<typename P >

typedef Product::FactoryKeyFxn utility::factory::Factory::KeyFxn

◆ KeyP

template<typename P >

typedef Product::FactoryKeyP utility::factory::Factory::KeyP

◆ Product

template<typename P >

typedef P utility::factory::Factory::Product

◆ ProductP

template<typename P >

typedef Product::FactoryProductP utility::factory::Factory::ProductP

◆ PtrRegistry

template<typename P >

typedef std::map< KeyP, Create > utility::factory::Factory::PtrRegistry

private

◆ Registry

template<typename P >

typedef std::map< Key, Create > utility::factory::Factory::Registry

private

Constructor & Destructor Documentation

◆ Factory()

template<typename P >

utility::factory::Factory::Factory ( )

inlineprivatedefault

Default constructor.

Member Function Documentation

◆ add() [1/3]

template<typename P >

static void utility::factory::Factory< P >::add	(	Key const &	key,
		Create	create
	)

inlinestatic

Add a Product to the registry.

References utility::factory::Factory::create(), subloop_histogram::key, and utility::factory::Factory::registry().

Referenced by job_manager.MoveStatsWindow::__init__(), pyrosetta.bindings.pose.ResidueLabelAccessor::discard(), and utility::factory::Registrant::Registrant().

◆ add() [2/3]

template<typename P >

static void utility::factory::Factory< P >::add	(	KeyFxn	key_fxn,
		Create	create
	)

inlinestatic

Add a Product to the function registry.

References utility::factory::Factory::create(), and utility::factory::Factory::fxn_registry().

Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().

◆ add() [3/3]

template<typename P >

static void utility::factory::Factory< P >::add	(	KeyP const &	key_p,
		Create	create
	)

inlinestatic

Add a Product to the pointer registry.

References utility::factory::Factory::create(), and utility::factory::Factory::ptr_registry().

Referenced by job_manager.MoveStatsWindow::__init__(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().

◆ create() [1/2]

template<typename P >

static ProductP utility::factory::Factory::create ( Key const & key )

inlinestatic

Create a Product from key.

References debug_assert, subloop_histogram::key, test.G200_Module_Region::reg, and utility::factory::Factory::registry().

Referenced by utility::factory::Factory::add().

◆ create() [2/2]

template<typename P >

static ProductP utility::factory::Factory< P >::create	(	Key const &	key,
		Arg &	arg
	)

inlinestatic

Create a Product from key and 1 argument.

References arg(), debug_assert, subloop_histogram::key, test.G200_Module_Region::reg, and utility::factory::Factory::registry().

◆ fxn_registry()

template<typename P >

static FxnRegistry& utility::factory::Factory::fxn_registry ( )

inlinestaticprivate

Key function registry.

Referenced by utility::factory::Factory::add(), utility::factory::Factory::fxn_registry_transfer(), and utility::factory::Factory::remove().

◆ fxn_registry_transfer()

template<typename P >

static void utility::factory::Factory::fxn_registry_transfer ( Registry & reg )

inlinestaticprivate

Transfer key function registry to key registry.

References test.T009_Exceptions::e, utility::factory::Factory::fxn_registry(), create_a3b_hbs::i, and test.G200_Module_Region::reg.

Referenced by utility::factory::Factory::registry().

◆ has()

template<typename P >

static bool utility::factory::Factory::has ( Key const & key )

inlinestatic

Has a Product with key?

References subloop_histogram::key, test.G200_Module_Region::reg, and utility::factory::Factory::registry().

◆ ptr_registry()

template<typename P >

static PtrRegistry& utility::factory::Factory::ptr_registry ( )

inlinestaticprivate

Key pointer registry.

Referenced by utility::factory::Factory::add(), utility::factory::Factory::ptr_registry_transfer(), and utility::factory::Factory::remove().

◆ ptr_registry_transfer()

template<typename P >

static void utility::factory::Factory::ptr_registry_transfer ( Registry & reg )

inlinestaticprivate

Transfer key pointer registry to key registry.

References test.T009_Exceptions::e, create_a3b_hbs::i, utility::factory::Factory::ptr_registry(), and test.G200_Module_Region::reg.

Referenced by utility::factory::Factory::registry().

◆ registry()

template<typename P >

static Registry& utility::factory::Factory::registry ( )

inlinestaticprivate

Key registry.

Note: Precondition: Keys referenced by pointer and function registries must have been constructed

References utility::factory::Factory::fxn_registry_transfer(), and utility::factory::Factory::ptr_registry_transfer().

Referenced by utility::factory::Factory::add(), utility::factory::Factory::create(), utility::factory::Factory::has(), and utility::factory::Factory::remove().

◆ remove() [1/3]

template<typename P >

static void utility::factory::Factory::remove ( Key const & key )

inlinestatic

Remove a Product from the registry.

References subloop_histogram::key, and utility::factory::Factory::registry().

◆ remove() [2/3]

template<typename P >

static void utility::factory::Factory::remove ( KeyFxn key_fxn )

inlinestatic

Remove a Product from the function registry.

References utility::factory::Factory::fxn_registry().

◆ remove() [3/3]

template<typename P >

static void utility::factory::Factory::remove ( KeyP const & key_p )

inlinestatic

Remove a Product from the pointer registry.

References utility::factory::Factory::ptr_registry().

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

src/utility/factory/Factory.fwd.hh
src/utility/factory/Factory.hh

Public Types

Static Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Detailed Description

template<typename P> class utility::factory::Factory< P >

Member Typedef Documentation

◆ Arg

◆ Create

◆ FxnRegistry

◆ Key

◆ KeyFxn

◆ KeyP

◆ Product

◆ ProductP

◆ PtrRegistry

◆ Registry

Constructor & Destructor Documentation

◆ Factory()

Member Function Documentation

◆ add() [1/3]

◆ add() [2/3]

◆ add() [3/3]

◆ create() [1/2]

◆ create() [2/2]

◆ fxn_registry()

◆ fxn_registry_transfer()

◆ has()

◆ ptr_registry()

◆ ptr_registry_transfer()

◆ registry()

◆ remove() [1/3]

◆ remove() [2/3]

◆ remove() [3/3]

template<typename P>
class utility::factory::Factory< P >