deepstream::CommonFactory Class Reference

Detailed Description

r\Represents a unified interface for managing custom objects and factories

Definition at line 35 of file common_factory.hpp.

Public Member Functions
virtual	~CommonFactory ()=default
	CommonFactory (const CommonFactory &)=delete
	CommonFactory (CommonFactory &&)=delete
CommonFactory &	operator= (const CommonFactory &)=delete
CommonFactory &	operator= (CommonFactory &&)=delete
virtual std::unique_ptr< CustomObject >	createObject (const std::string &factory_key, const std::string &name)=0
	Create a custom object from a custom factory. More...
virtual bool	addCustomFactory (CustomFactory *factory, const char *key)=0
	Add a custom factory. More...
virtual CustomFactory *	getCustomFactory (const char *factory_name)=0
	Find a custom factory that supports a certan object type. More...

Static Public Member Functions
static CommonFactory &	getInstance ()
	Acquire the reference of the singleton. More...

Protected Member Functions
	CommonFactory ()=default

Static Protected Member Functions
static bool	_load (const std::string &plugin_name)

Constructor & Destructor Documentation

~CommonFactory()

virtual deepstream::CommonFactory::~CommonFactory ( )

virtualdefault

CommonFactory() [1/3]

deepstream::CommonFactory::CommonFactory ( const CommonFactory &  )

delete

CommonFactory() [2/3]

deepstream::CommonFactory::CommonFactory ( CommonFactory &&  )

delete

CommonFactory() [3/3]

deepstream::CommonFactory::CommonFactory ( )

protecteddefault

Member Function Documentation

_load()

static bool deepstream::CommonFactory::_load ( const std::string &  plugin_name )

staticprotected

addCustomFactory()

virtual bool deepstream::CommonFactory::addCustomFactory ( CustomFactory *  factory, const char *  key  )

pure virtual

Add a custom factory.

Once a custom factory is added, the type of object defined within the factory can be created through common factory interface.

Parameters

[in]	factory	pointer to the factory
[in]	key	key used to identify the factory

createObject()

virtual std::unique_ptr<CustomObject> deepstream::CommonFactory::createObject ( const std::string &  factory_key, const std::string &  name  )

pure virtual

Create a custom object from a custom factory.

Parameters

[in]	factory_key	identifier of the factory where the custom object is supported
[in]	name	name for the object to be created.

getCustomFactory()

virtual CustomFactory* deepstream::CommonFactory::getCustomFactory ( const char *  factory_name )

pure virtual

Find a custom factory that supports a certan object type.

Parameters

[in]

factory_name

name of the factory

Returns

Pointer of a custom factory that supports the type

getInstance()

static CommonFactory& deepstream::CommonFactory::getInstance ( )

static

Acquire the reference of the singleton.

operator=() [1/2]

CommonFactory& deepstream::CommonFactory::operator= ( CommonFactory &&  )

delete

operator=() [2/2]

CommonFactory& deepstream::CommonFactory::operator= ( const CommonFactory &  )

delete

---

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

• common_factory.hpp