nx_metadata_sdk  1.0
Metadata SDK
engine.h
1 // Copyright 2018-present Network Optix, Inc. Licensed under MPL 2.0: www.mozilla.org/MPL/2.0/
2 
3 #pragma once
4 
5 #include <string>
6 #include <map>
7 #include <mutex>
8 
9 #include <nx/sdk/i_string_map.h>
10 #include <nx/sdk/analytics/i_engine.h>
11 
12 #include <nx/sdk/result.h>
13 #include <nx/sdk/uuid.h>
14 
15 #include <nx/sdk/helpers/ref_countable.h>
16 #include <nx/sdk/ptr.h>
17 #include <nx/sdk/helpers/log_utils.h>
18 
19 namespace nx::sdk::analytics {
20 
32 class Engine: public RefCountable<IEngine>
33 {
34 protected:
35  LogUtils logUtils;
36 
37 protected:
42  Engine(bool enableOutput, const std::string& pluginInstanceId = "");
43 
44  virtual std::string manifestString() const = 0;
45 
51  virtual Result<const ISettingsResponse*> settingsReceived() { return nullptr; }
52 
62  std::string settingValue(const std::string& settingName) const;
63 
72  std::map<std::string, std::string> currentSettings() const;
73 
85  const std::string& actionId,
86  Uuid objectTrackId,
87  Uuid deviceId,
88  int64_t timestampUs,
89  Ptr<IObjectTrackInfo> trackInfo,
90  const std::map<std::string, std::string>& params);
91 
98  IPluginDiagnosticEvent::Level level,
99  std::string caption,
100  std::string description) const;
101 
102  IHandler* handler() const { return m_handler.get(); }
103 
104  virtual void doGetSettingsOnActiveSettingChange(
106  const IActiveSettingChangedAction* activeSettingChangedAction) override;
107 
108 public:
109  virtual ~Engine() override;
110 
111 //-------------------------------------------------------------------------------------------------
112 // Not intended to be used by a descendant.
113 
114 public:
115  virtual void setEngineInfo(const IEngineInfo* engineInfo) override;
116  virtual void setHandler(IEngine::IHandler* handler) override;
117  virtual bool isCompatible(const IDeviceInfo* deviceInfo) const override;
118 
119 protected:
120  virtual void doSetSettings(
121  Result<const ISettingsResponse*>* outResult, const IStringMap* settings) override;
122 
123  virtual void getPluginSideSettings(Result<const ISettingsResponse*>* outResult) const override;
124 
125  virtual void getManifest(Result<const IString*>* outResult) const override;
126 
127  virtual void doExecuteAction(
128  Result<IAction::Result>* outResult, const IAction* action) override;
129 
130 private:
131  mutable std::mutex m_mutex;
132  std::map<std::string, std::string> m_settings;
133  Ptr<IEngine::IHandler> m_handler;
134  std::string m_pluginInstanceId;
135 };
136 
137 } // namespace nx::sdk::analytics
Definition: i_string_map.h:9
Definition: i_active_setting_changed_action.h:14
void pushPluginDiagnosticEvent(IPluginDiagnosticEvent::Level level, std::string caption, std::string description) const
Definition: engine.cpp:70
std::map< std::string, std::string > currentSettings() const
Definition: engine.cpp:54
Definition: ptr.h:18
std::string settingValue(const std::string &settingName) const
Definition: engine.cpp:43
Engine(bool enableOutput, const std::string &pluginInstanceId="")
Definition: engine.cpp:34
Definition: consuming_device_agent.cpp:21
Definition: uuid.h:21
Definition: i_device_info.h:13
Definition: result.h:46
Definition: log_utils.h:25
virtual Result< IAction::Result > executeAction(const std::string &actionId, Uuid objectTrackId, Uuid deviceId, int64_t timestampUs, Ptr< IObjectTrackInfo > trackInfo, const std::map< std::string, std::string > &params)
Definition: engine.cpp:59
virtual Result< const ISettingsResponse * > settingsReceived()
Definition: engine.h:51
Definition: engine.h:32
Definition: ref_countable.h:83