i_engine.h

// Copyright 2018-present Network Optix, Inc. Licensed under MPL 2.0: www.mozilla.org/MPL/2.0/

#pragma once

#include <nx/sdk/i_active_setting_changed_action.h>
#include <nx/sdk/i_active_setting_changed_response.h>
#include <nx/sdk/i_device_info.h>
#include <nx/sdk/i_integration_diagnostic_event.h>
#include <nx/sdk/i_settings_response.h>
#include <nx/sdk/i_string.h>
#include <nx/sdk/interface.h>
#include <nx/sdk/result.h>

#include "i_action.h"
#include "i_device_agent.h"
#include "i_engine_info.h"

namespace nx::sdk::analytics {

class IIntegration; //< Forward declaration for the parent object.

class IEngine0: public Interface<IEngine0>
{
public:
    static auto interfaceId() { return makeId("nx::sdk::analytics::IEngine"); }

    class IHandler: public Interface<IHandler>
    {
    public:
        static auto interfaceId() { return makeId("nx::sdk::analytics::IEngine::IHandler"); }

        virtual ~IHandler() = default;
        virtual void handleIntegrationDiagnosticEvent(IIntegrationDiagnosticEvent* event) = 0;

        virtual void pushManifest(const IString* manifest) = 0;
    };

    virtual void setEngineInfo(const IEngineInfo* engineInfo) = 0;

    protected: virtual void doSetSettings(
        Result<const ISettingsResponse*>* outResult, const IStringMap* settings) = 0;
    public: Result<const ISettingsResponse*> setSettings(const IStringMap* settings)
    {
        Result<const ISettingsResponse*> result;
        doSetSettings(&result, settings);
        return result;
    }

    protected: virtual void getIntegrationSideSettings(
        Result<const ISettingsResponse*>* outResult) const = 0;
    public: Result<const ISettingsResponse*> integrationSideSettings() const
    {
        Result<const ISettingsResponse*> result;
        getIntegrationSideSettings(&result);
        return result;
    }

    protected: virtual void getManifest(Result<const IString*>* outResult) const = 0;
    public: Result<const IString*> manifest() const
    {
        Result<const IString*> result;
        getManifest(&result);
        return result;
    }

    virtual bool isCompatible(const IDeviceInfo* deviceInfo) const = 0;

    protected: virtual void doObtainDeviceAgent(
        Result<IDeviceAgent*>* outResult, const IDeviceInfo* deviceInfo) = 0;
    public: Result<IDeviceAgent*> obtainDeviceAgent(const IDeviceInfo* deviceInfo)
    {
        Result<IDeviceAgent*> result;
        doObtainDeviceAgent(&result, deviceInfo);
        return result;
    }

    protected: virtual void doExecuteAction(
        Result<IAction::Result>* outResult, const IAction* action) = 0;
    public: Result<IAction::Result> executeAction(const IAction* action)
    {
        Result<IAction::Result> result;
        doExecuteAction(&result, action);
        return result;
    }

    virtual void setHandler(IHandler* handler) = 0;
};

class IEngine: public Interface<IEngine, IEngine0>
{
public:
    static auto interfaceId() { return makeId("nx::sdk::analytics::IEngine1"); }

    protected: virtual void doGetSettingsOnActiveSettingChange(
        Result<const IActiveSettingChangedResponse*>* outResult,
        const IActiveSettingChangedAction* activeSettingChangedAction) = 0;
    public: Result<const IActiveSettingChangedResponse*> getSettingsOnActiveSettingChange(
        const IActiveSettingChangedAction* activeSettingChangedAction)
    {
        Result<const IActiveSettingChangedResponse*> result;
        doGetSettingsOnActiveSettingChange(&result, activeSettingChangedAction);
        return result;
    }
};
using IEngine1 = IEngine;

} // namespace nx::sdk::analytics