stub_analytics_plugin
1.6
Network Optix Video Analytics SDK
|
#include <engine.h>
Public Member Functions | |
virtual IPlugin * | plugin () const override |
virtual void | setSettings (const nx::sdk::IStringMap *settings) override |
virtual nx::sdk::IStringMap * | pluginSideSettings () const override |
virtual const IString * | manifest (Error *error) const override |
virtual void | executeAction (IAction *action, Error *outError) override |
virtual nx::sdk::Error | setHandler (IEngine::IHandler *handler) override |
virtual bool | isCompatible (const nx::sdk::IDeviceInfo *deviceInfo) const override |
![]() | |
RefCountable (const RefCountable &)=delete | |
RefCountable (RefCountable &&)=delete | |
RefCountable & | operator= (const RefCountable &)=delete |
RefCountable & | operator= (RefCountable &&)=delete |
virtual int | addRef () const override |
virtual int | releaseRef () const override |
int | refCount () const |
virtual IRefCountable * | queryInterface (InterfaceId id) |
const IRefCountable * | queryInterface (InterfaceId id) const |
Interface * | queryInterface () |
const Interface * | queryInterface () const |
Protected Member Functions | |
Engine (IPlugin *plugin, bool enableOutput, const std::string &printPrefix="") | |
virtual std::string | manifest () const =0 |
virtual void | settingsReceived () |
std::string | getParamValue (const char *paramName) |
virtual void | executeAction (const std::string &, Uuid, Uuid, int64_t, const std::map< std::string, std::string > &, std::string *, std::string *, Error *) |
void | pushPluginEvent (nx::sdk::IPluginEvent::Level level, std::string caption, std::string description) |
template<typename DerivedPlugin > | |
DerivedPlugin * | pluginCasted () |
IEngine::IHandler * | handler () const |
Protected Attributes | |
LogUtils | logUtils |
Base class for a typical implementation of an Analytics Engine. Hides many technical details of the Analytics Plugin SDK, but may limit plugin capabilities - use only when suitable.
To use NX_PRINT/NX_OUTPUT in a derived class with the prefix defined by this class, add the following to the derived class .cpp:
#define NX_PRINT_PREFIX (this->logUtils.printPrefix)
#include <nx/kit/debug.h>
|
protected |
enableOutput | Enables NX_OUTPUT. Typically, use NX_DEBUG_ENABLE_OUTPUT as a value. |
printPrefix | Prefix for NX_PRINT and NX_OUTPUT. If empty, will be made from libName. |
|
inlineprotectedvirtual |
Action handler. Called when some action defined by this engine is triggered by Server.
actionId | Id of the action being triggered. |
objectId | Id of a metadata object for which the action has been triggered. |
params | If the engine manifest defines params for the action being triggered, contains their values after they are filled by the user via Client form. Otherwise, empty. |
outActionUrl | If set by this call, Client will open this URL in an embedded browser. |
outMessageToUser | If set by this call, Client will show this text to the user. |
Reimplemented in nx::vms_server_plugins::analytics::stub::Engine.
|
protected |
Provides access to the Plugin global settings stored by the server.
|
inlineprotected |
Intended to be called from a method of a derived class overriding plugin().
|
protected |
Sends a PluginEvent to the Server. Can be called from any thread, but if called before settingsReceived() was called, will be ignored in case setHandler() was not called yet.
|
inlineprotectedvirtual |
Called when the settings are received from the server (even if the values are not changed). Should perform any required (re)initialization. Called even if the settings model is empty.
Reimplemented in nx::vms_server_plugins::analytics::stub::Engine.