stub_analytics_plugin  1.6
Network Optix Video Analytics SDK
Public Types | Public Member Functions | List of all members
nx::sdk::analytics::Plugin Class Reference

#include <plugin.h>

Inheritance diagram for nx::sdk::analytics::Plugin:
nx::sdk::RefCountable< IPlugin > nx::sdk::IPlugin nx::sdk::Interface< IPlugin > nx::sdk::IRefCountable

Public Types

using CreateEngine = std::function< IEngine *(IPlugin *plugin)>
 
- Public Types inherited from nx::sdk::IPlugin
typedef IPlugin *(* EntryPointFunc) ()
 

Public Member Functions

 Plugin (std::string libName, std::string pluginManifest, CreateEngine createEngine)
 
const Ptr< IUtilityProvider > & utilityProvider () const
 
virtual const char * name () const override
 
virtual void setUtilityProvider (IUtilityProvider *utilityProvider) override
 
virtual const IStringmanifest (Error *outError) const override
 
virtual IEnginecreateEngine (Error *outError) override
 
- Public Member Functions inherited from nx::sdk::RefCountable< IPlugin >
 RefCountable (const RefCountable &)=delete
 
 RefCountable (RefCountable &&)=delete
 
RefCountableoperator= (const RefCountable &)=delete
 
RefCountableoperator= (RefCountable &&)=delete
 
virtual int addRef () const override
 
virtual int releaseRef () const override
 
int refCount () const
 
virtual IRefCountablequeryInterface (InterfaceId id)
 
const IRefCountablequeryInterface (InterfaceId id) const
 
InterfacequeryInterface ()
 
const InterfacequeryInterface () const
 
- Public Member Functions inherited from nx::sdk::Interface< IPlugin >
virtual IRefCountablequeryInterface (IRefCountable::InterfaceId id) override
 
virtual IRefCountablequeryInterface (InterfaceId id)
 
const IRefCountablequeryInterface (InterfaceId id) const
 
InterfacequeryInterface ()
 
const InterfacequeryInterface () const
 
- Public Member Functions inherited from nx::sdk::IRefCountable
virtual ~IRefCountable ()=default
 
const IRefCountablequeryInterface (InterfaceId id) const
 
template<class Interface >
InterfacequeryInterface ()
 
template<class Interface >
const InterfacequeryInterface () const
 

Additional Inherited Members

- Static Public Member Functions inherited from nx::sdk::IPlugin
static auto interfaceId ()
 
- Static Public Member Functions inherited from nx::sdk::IRefCountable
static auto interfaceId ()
 
- Static Public Attributes inherited from nx::sdk::IPlugin
static constexpr const char * kEntryPointFuncName = "createNxPlugin"
 
- Protected Member Functions inherited from nx::sdk::Interface< IPlugin >
IRefCountablequeryInterfaceSupportingDeprecatedId (IRefCountable::InterfaceId id, const Uuid &deprecatedInterfaceId)
 

Detailed Description

Base class for a typical implementation of an Analytics Plugin. Hides many technical details of the Analytics Plugin SDK, but may limit plugin capabilities - use only when suitable.

Constructor & Destructor Documentation

◆ Plugin()

nx::sdk::analytics::Plugin::Plugin ( std::string  libName,
std::string  pluginManifest,
CreateEngine  createEngine 
)
Parameters
libNameName of the plugin library. It's needed for the logging.
pluginManifestPlugin manifest to be returned from the manifest method.
createEngineFunctor for engine creation.

Member Function Documentation

◆ name()

const char * nx::sdk::analytics::Plugin::name ( ) const
overridevirtual

Name of the plugin, used for information purpose only.

Implements nx::sdk::IPlugin.

◆ setUtilityProvider()

void nx::sdk::analytics::Plugin::setUtilityProvider ( IUtilityProvider utilityProvider)
overridevirtual

Provides an object which the plugin can use for calling back to access some data and functionality provided by the process that uses the plugin.

For details, see the documentation for IUtilityProvider.

Implements nx::sdk::IPlugin.


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