nx_metadata_sdk  1.0
Metadata SDK
i_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 <nx/sdk/interface.h>
6 #include <nx/sdk/result.h>
7 
8 #include <nx/sdk/i_device_info.h>
9 #include <nx/sdk/i_string.h>
10 #include <nx/sdk/i_plugin_diagnostic_event.h>
11 
12 #include <nx/sdk/i_active_setting_changed_action.h>
13 #include <nx/sdk/i_active_setting_changed_response.h>
14 #include <nx/sdk/i_settings_response.h>
15 
16 #include "i_device_agent.h"
17 #include "i_engine_info.h"
18 #include "i_action.h"
19 
20 namespace nx::sdk::analytics {
21 
22 class IPlugin; //< Forward declaration for the parent object.
23 
24 class IEngine0: public Interface<IEngine0>
25 {
26 public:
27  static auto interfaceId() { return makeId("nx::sdk::analytics::IEngine"); }
28 
29  class IHandler: public Interface<IHandler>
30  {
31  public:
32  static auto interfaceId() { return makeId("nx::sdk::analytics::IEngine::IHandler"); }
33 
34  virtual ~IHandler() = default;
35  virtual void handlePluginDiagnosticEvent(IPluginDiagnosticEvent* event) = 0;
36  };
37 
42  virtual void setEngineInfo(const IEngineInfo* engineInfo) = 0;
43 
45  protected: virtual void doSetSettings(
46  Result<const ISettingsResponse*>* outResult, const IStringMap* settings) = 0;
63  {
65  doSetSettings(&result, settings);
66  return result;
67  }
68 
70  protected: virtual void getPluginSideSettings(
71  Result<const ISettingsResponse*>* outResult) const = 0;
84  {
86  getPluginSideSettings(&result);
87  return result;
88  }
89 
91  protected: virtual void getManifest(Result<const IString*>* outResult) const = 0;
105  {
106  Result<const IString*> result;
107  getManifest(&result);
108  return result;
109  }
110 
115  virtual bool isCompatible(const IDeviceInfo* deviceInfo) const = 0;
116 
118  protected: virtual void doObtainDeviceAgent(
119  Result<IDeviceAgent*>* outResult, const IDeviceInfo* deviceInfo) = 0;
131  {
132  Result<IDeviceAgent*> result;
133  doObtainDeviceAgent(&result, deviceInfo);
134  return result;
135  }
136 
138  protected: virtual void doExecuteAction(
139  Result<IAction::Result>* outResult, const IAction* action) = 0;
148  {
150  doExecuteAction(&result, action);
151  return result;
152  }
153 
158  virtual void setHandler(IHandler* handler) = 0;
159 };
160 
174 class IEngine: public Interface<IEngine, IEngine0>
175 {
176 public:
177  static auto interfaceId() { return makeId("nx::sdk::analytics::IEngine1"); }
178 
180  protected: virtual void doGetSettingsOnActiveSettingChange(
182  const IActiveSettingChangedAction* activeSettingChangedAction) = 0;
195  const IActiveSettingChangedAction* activeSettingChangedAction)
196  {
198  doGetSettingsOnActiveSettingChange(&result, activeSettingChangedAction);
199  return result;
200  }
201 };
202 using IEngine1 = IEngine;
203 
204 } // namespace nx::sdk::analytics
Definition: i_plugin_diagnostic_event.h:13
Result< IAction::Result > executeAction(const IAction *action)
Definition: i_engine.h:147
virtual void setEngineInfo(const IEngineInfo *engineInfo)=0
Definition: i_string_map.h:9
virtual void doExecuteAction(Result< IAction::Result > *outResult, const IAction *action)=0
Definition: i_active_setting_changed_action.h:14
virtual void doSetSettings(Result< const ISettingsResponse *> *outResult, const IStringMap *settings)=0
Definition: interface.h:48
Definition: i_action.h:18
Result< const ISettingsResponse * > setSettings(const IStringMap *settings)
Definition: i_engine.h:62
Result< const IString * > manifest() const
Definition: i_engine.h:104
virtual void getPluginSideSettings(Result< const ISettingsResponse *> *outResult) const =0
virtual void setHandler(IHandler *handler)=0
Definition: i_engine.h:174
Definition: consuming_device_agent.cpp:21
Definition: i_device_info.h:13
Definition: result.h:46
Definition: i_engine_info.h:10
Result< const IActiveSettingChangedResponse * > getSettingsOnActiveSettingChange(const IActiveSettingChangedAction *activeSettingChangedAction)
Definition: i_engine.h:194
virtual void doObtainDeviceAgent(Result< IDeviceAgent *> *outResult, const IDeviceInfo *deviceInfo)=0
virtual void doGetSettingsOnActiveSettingChange(Result< const IActiveSettingChangedResponse *> *outResult, const IActiveSettingChangedAction *activeSettingChangedAction)=0
virtual void getManifest(Result< const IString *> *outResult) const =0
Result< IDeviceAgent * > obtainDeviceAgent(const IDeviceInfo *deviceInfo)
Definition: i_engine.h:130
virtual bool isCompatible(const IDeviceInfo *deviceInfo) const =0
Definition: i_engine.h:24
static constexpr const InterfaceId * makeId(const char(&charArray)[len])
Definition: i_ref_countable.h:76
Result< const ISettingsResponse * > pluginSideSettings() const
Definition: i_engine.h:83