DeviceFinder.h

Go to the documentation of this file.

#pragma once
#include <NDEVR/String.h>
#include <NDEVR/Dictionary.h>
#include <NDEVR/Connection.h>
#include <QPointer>
namespace NDEVR
{
    class DesignObjectLookup;
    class ProgressInfo;
    class Device;
    class Connection;
    class LogManager;
    /**--------------------------------------------------------------------------------------------------
    \brief A series of paths to use for finding potential hardware connections. Used with DeviceFinder.
    **/
    struct HardwareSearchPathParameters
    {
        Buffer<String> custom_connections;
        DesignObjectLookup* lookup = nullptr;
        ProgressInfo* raw_network_log = nullptr;
        ProgressInfo* connection_status_log = nullptr;
        ProgressInfo* main_log = nullptr;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Options for finding active hardware connectons. Used with DeviceFinder.
    **/
    struct HardwareSearchParameters
    {
        Buffer<QPointer<Connection>> connections_to_search;
        DesignObjectLookup* lookup = nullptr;
        ProgressInfo* raw_network_log = nullptr;
        ProgressInfo* main_log = nullptr;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Based class for finding devices connected to the system.
    **/
    class DeviceFinder
    {
    public:
        [[nodiscard]] virtual Buffer<QPointer<Connection>> possibleConnections(const HardwareSearchPathParameters&) const { return Buffer<QPointer<Connection>>(); };
        [[nodiscard]] virtual Dictionary<String, Device*> findDevices(const HardwareSearchParameters&) const { return Dictionary<String, Device*>(); };
    };
}