NVIDIA DeepStream SDK API Reference

9.1 Release
deepstream::CommonFactory Class Referenceabstract

Detailed Description

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

Definition at line 40 of file service-maker/includes/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...
 
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...
 
static CommonFactory & getInstance ()
 Acquire the reference of the singleton. More...
 

Protected Member Functions

 CommonFactory ()=default
 
 CommonFactory ()=default
 

Static Protected Member Functions

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

Constructor & Destructor Documentation

◆ ~CommonFactory() [1/2]

virtual deepstream::CommonFactory::~CommonFactory ( )
virtualdefault

◆ CommonFactory() [1/6]

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

◆ CommonFactory() [2/6]

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

◆ CommonFactory() [3/6]

deepstream::CommonFactory::CommonFactory ( )
protecteddefault

◆ ~CommonFactory() [2/2]

virtual deepstream::CommonFactory::~CommonFactory ( )
virtualdefault

◆ CommonFactory() [4/6]

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

◆ CommonFactory() [5/6]

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

◆ CommonFactory() [6/6]

deepstream::CommonFactory::CommonFactory ( )
protecteddefault

Member Function Documentation

◆ _load() [1/2]

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

◆ _load() [2/2]

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

◆ addCustomFactory() [1/2]

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]factorypointer to the factory
[in]keykey used to identify the factory

◆ addCustomFactory() [2/2]

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]factorypointer to the factory
[in]keykey used to identify the factory

◆ createObject() [1/2]

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_keyidentifier of the factory where the custom object is supported
[in]namename for the object to be created.

◆ createObject() [2/2]

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_keyidentifier of the factory where the custom object is supported
[in]namename for the object to be created.

◆ getCustomFactory() [1/2]

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

Find a custom factory that supports a certan object type.

Parameters
[in]factory_namename of the factory
Returns
Pointer of a custom factory that supports the type

◆ getCustomFactory() [2/2]

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

Find a custom factory that supports a certan object type.

Parameters
[in]factory_namename of the factory
Returns
Pointer of a custom factory that supports the type

◆ getInstance() [1/2]

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

Acquire the reference of the singleton.

◆ getInstance() [2/2]

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

Acquire the reference of the singleton.

◆ operator=() [1/4]

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

◆ operator=() [2/4]

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

◆ operator=() [3/4]

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

◆ operator=() [4/4]

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

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