nx_metadata_sdk  1.0
Metadata SDK
Classes | Public Member Functions | Protected Member Functions | List of all members
nx::vms_server_plugins::analytics::stub::diagnostic_events::Engine Class Reference
Inheritance diagram for nx::vms_server_plugins::analytics::stub::diagnostic_events::Engine:
nx::sdk::analytics::Engine nx::sdk::RefCountable< IEngine >

Public Member Functions

 Engine (nx::sdk::analytics::Plugin *plugin)
 
nx::sdk::analytics::Plugin *const plugin () const
 
- Public Member Functions inherited from nx::sdk::analytics::Engine
virtual void setEngineInfo (const IEngineInfo *engineInfo) override
 
virtual void setHandler (IEngine::IHandler *handler) override
 
virtual bool isCompatible (const IDeviceInfo *deviceInfo) const override
 
- Public Member Functions inherited from nx::sdk::RefCountable< IEngine >
 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
 

Protected Member Functions

virtual std::string manifestString () const override
 
virtual nx::sdk::Result< const nx::sdk::ISettingsResponse * > settingsReceived () override
 
virtual void doObtainDeviceAgent (nx::sdk::Result< nx::sdk::analytics::IDeviceAgent *> *outResult, const nx::sdk::IDeviceInfo *deviceInfo) override
 
- Protected Member Functions inherited from nx::sdk::analytics::Engine
 Engine (bool enableOutput, const std::string &pluginInstanceId="")
 
std::string settingValue (const std::string &settingName) const
 
std::map< std::string, std::string > currentSettings () const
 
virtual Result< IAction::ResultexecuteAction (const std::string &actionId, Uuid objectTrackId, Uuid deviceId, int64_t timestampUs, Ptr< IObjectTrackInfo > trackInfo, const std::map< std::string, std::string > &params)
 
void pushPluginDiagnosticEvent (IPluginDiagnosticEvent::Level level, std::string caption, std::string description) const
 
IHandler * handler () const
 
virtual void doGetSettingsOnActiveSettingChange (Result< const IActiveSettingChangedResponse *> *outResult, const IActiveSettingChangedAction *activeSettingChangeAction) override
 
virtual void doSetSettings (Result< const ISettingsResponse *> *outResult, const IStringMap *settings) override
 
virtual void getPluginSideSettings (Result< const ISettingsResponse *> *outResult) const override
 
virtual void getManifest (Result< const IString *> *outResult) const override
 
virtual void doExecuteAction (Result< IAction::Result > *outResult, const IAction *action) override
 

Additional Inherited Members

- Protected Attributes inherited from nx::sdk::analytics::Engine
LogUtils logUtils
 

Member Function Documentation

◆ settingsReceived()

Result< const ISettingsResponse * > nx::vms_server_plugins::analytics::stub::diagnostic_events::Engine::settingsReceived ( )
overrideprotectedvirtual

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.

Returns
Error messages per setting (if any), as in IEngine::setSettings().

Reimplemented from nx::sdk::analytics::Engine.


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