engine.h

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

#pragma once

#include <map>
#include <mutex>
#include <string>

#include <nx/sdk/analytics/i_engine.h>
#include <nx/sdk/helpers/log_utils.h>
#include <nx/sdk/helpers/ref_countable.h>
#include <nx/sdk/i_string_map.h>
#include <nx/sdk/ptr.h>
#include <nx/sdk/result.h>
#include <nx/sdk/uuid.h>

namespace nx::sdk::analytics {

class Engine: public RefCountable<IEngine>
{
protected:
    LogUtils logUtils;

protected:
    Engine(bool enableOutput, const std::string& integrationInstanceId = "");

    virtual std::string manifestString() const = 0;

    virtual Result<const ISettingsResponse*> settingsReceived() { return nullptr; }

    std::string settingValue(const std::string& settingName) const;

    std::map<std::string, std::string> currentSettings() const;

    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);

    void pushIntegrationDiagnosticEvent(
        IIntegrationDiagnosticEvent::Level level,
        std::string caption,
        std::string description) const;

    IHandler* handler() const { return m_handler.get(); }

    virtual void doGetSettingsOnActiveSettingChange(
        Result<const IActiveSettingChangedResponse*>* outResult,
        const IActiveSettingChangedAction* activeSettingChangedAction) override;

    void pushManifest(const std::string& manifest);

public:
    virtual ~Engine() override;

//-------------------------------------------------------------------------------------------------
// Not intended to be used by a descendant.

public:
    virtual void setEngineInfo(const IEngineInfo* engineInfo) override;
    virtual void setHandler(IEngine::IHandler* handler) override;
    virtual bool isCompatible(const IDeviceInfo* deviceInfo) const override;

protected:
    virtual void doSetSettings(
        Result<const ISettingsResponse*>* outResult, const IStringMap* settings) override;

    virtual void getIntegrationSideSettings(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;

private:
    mutable std::mutex m_mutex;
    std::map<std::string, std::string> m_settings;
    Ptr<IEngine::IHandler> m_handler;
    std::string m_integrationInstanceId;
};

} // namespace nx::sdk::analytics