nx_metadata_sdk  1.0
Metadata SDK
i_device_agent.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_string_map.h>
9 #include <nx/sdk/i_string.h>
10 #include <nx/sdk/i_plugin_diagnostic_event.h>
11 #include <nx/sdk/i_settings_response.h>
12 
13 #include <nx/sdk/analytics/i_metadata_types.h>
14 #include <nx/sdk/analytics/i_metadata_packet.h>
15 
16 namespace nx::sdk::analytics {
17 
18 class IEngine; //< Forward declaration for the parent object.
19 
31 class IDeviceAgent: public Interface<IDeviceAgent>
32 {
33 public:
34  static auto interfaceId() { return makeId("nx::sdk::analytics::IDeviceAgent"); }
35 
36  class IHandler0: public Interface<IHandler0>
37  {
38  public:
39  static auto interfaceId() { return makeId("nx::sdk::analytics::IDeviceAgent::IHandler"); }
40 
41  virtual ~IHandler0() = default;
42 
51  virtual void handleMetadata(IMetadataPacket* metadataPacket) = 0;
52 
53  virtual void handlePluginDiagnosticEvent(IPluginDiagnosticEvent* event) = 0;
54  };
55 
60  class IHandler: public Interface<IHandler, IHandler0>
61  {
62  public:
63  static auto interfaceId() { return makeId("nx::sdk::analytics::IDeviceAgent::IHandler1"); }
64 
66  virtual void pushManifest(const IString* manifest) = 0;
67  };
68 
70  protected: virtual void doSetSettings(
71  Result<const ISettingsResponse*>* outResult, const IStringMap* settings) = 0;
94  {
96  doSetSettings(&result, settings);
97  return result;
98  }
99 
101  protected: virtual void getPluginSideSettings(
102  Result<const ISettingsResponse*>* outResult) const = 0;
115  {
117  getPluginSideSettings(&result);
118  return result;
119  }
120 
122  protected: virtual void getManifest(Result<const IString*>* outResult) const = 0;
131  {
132  Result<const IString*> result;
133  getManifest(&result);
134  return result;
135  }
136 
143  virtual void setHandler(IHandler* handler) = 0;
144 
146  protected: virtual void doSetNeededMetadataTypes(
147  Result<void>* outResult, const IMetadataTypes* neededMetadataTypes) = 0;
154  public: Result<void> setNeededMetadataTypes(const IMetadataTypes* neededMetadataTypes)
155  {
156  Result<void> result;
157  doSetNeededMetadataTypes(&result, neededMetadataTypes);
158  return result;
159  }
160 };
161 using IDeviceAgent0 = IDeviceAgent;
162 
163 } // namespace nx::sdk::analytics
Definition: i_plugin_diagnostic_event.h:13
virtual void handleMetadata(IMetadataPacket *metadataPacket)=0
Definition: i_string_map.h:9
Definition: i_metadata_packet.h:14
Definition: i_device_agent.h:36
Definition: interface.h:48
Definition: i_device_agent.h:60
virtual void setHandler(IHandler *handler)=0
Result< const ISettingsResponse * > pluginSideSettings() const
Definition: i_device_agent.h:114
Definition: consuming_device_agent.cpp:22
Definition: i_metadata_types.h:11
Definition: result.h:80
virtual void doSetNeededMetadataTypes(Result< void > *outResult, const IMetadataTypes *neededMetadataTypes)=0
Definition: i_string.h:9
Result< const IString * > manifest() const
Definition: i_device_agent.h:130
virtual void pushManifest(const IString *manifest)=0
Result< void > setNeededMetadataTypes(const IMetadataTypes *neededMetadataTypes)
Definition: i_device_agent.h:154
Definition: result.h:46
virtual void getManifest(Result< const IString *> *outResult) const =0
Definition: i_device_agent.h:31
virtual void doSetSettings(Result< const ISettingsResponse *> *outResult, const IStringMap *settings)=0
virtual void getPluginSideSettings(Result< const ISettingsResponse *> *outResult) const =0
Result< const ISettingsResponse * > setSettings(const IStringMap *settings)
Definition: i_device_agent.h:93
static constexpr const InterfaceId * makeId(const char(&charArray)[len])
Definition: i_ref_countable.h:76