pluginapi.h

Go to the documentation of this file.

#ifndef INCLUDE_PLUGINAPI_H
#define INCLUDE_PLUGINAPI_H

#include <QObject>
#include <QList>

#include "export.h"
#include "plugin/plugininterface.h"

class QString;

class PluginManager;
class MessageQueue;
class PluginInstanceGUI;

class SDRBASE_API PluginAPI : public QObject {
    Q_OBJECT

public:
    struct SamplingDeviceRegistration 
    {
        QString m_deviceId;
        PluginInterface* m_plugin;
        SamplingDeviceRegistration(const QString& deviceId, PluginInterface* plugin) :
            m_deviceId(deviceId),
            m_plugin(plugin)
        { }
    };

    typedef QList<SamplingDeviceRegistration> SamplingDeviceRegistrations;

    struct ChannelRegistration
    {
        QString m_channelIdURI;       
        QString m_channelId;          
        PluginInterface* m_plugin;
        ChannelRegistration(const QString& channelIdURI, const QString& channelId, PluginInterface* plugin) :
            m_channelIdURI(channelIdURI),
            m_channelId(channelId),
            m_plugin(plugin)
        { }
    };

    typedef QList<ChannelRegistration> ChannelRegistrations;

    // Rx Channel stuff
    void registerRxChannel(const QString& channelIdURI, const QString& channelId, PluginInterface* plugin);
    ChannelRegistrations *getRxChannelRegistrations();

    // Tx Channel stuff
    void registerTxChannel(const QString& channelIdURI, const QString& channelId, PluginInterface* plugin);
    ChannelRegistrations *getTxChannelRegistrations();

    // Sample Source stuff
    void registerSampleSource(const QString& sourceName, PluginInterface* plugin);

    // Sample Sink stuff
    void registerSampleSink(const QString& sinkName, PluginInterface* plugin);

    // Sample MIMO stuff
    void registerSampleMIMO(const QString& sinkName, PluginInterface* plugin);

protected:
    PluginManager* m_pluginManager;

    PluginAPI(PluginManager* pluginManager);
    ~PluginAPI();

    friend class PluginManager;
};

#endif // INCLUDE_PLUGINAPI_H