bbob_interfaces.h

Go to the documentation of this file.

#ifndef BBOB_INTERFACES_H
#define BBOB_INTERFACES_H

#include <QStringList>
#include <QMap>
#include <QString>
#include <QDockWidget>

#include "bcore.h"

/**
  * For plugins to communicate, there is the "Message Bus". A set of functions
  * to pass data around plugins.
  */
/// Interface for ALL plugins to the core functions (engine)
class CoreInterface
{
public:
    virtual ~CoreInterface() {}

    /** Initialize with pointer to core class functions */
    virtual void CoreInit(const BCore* core) = 0;

    /** Dump all settings in plugin through core settings */
    virtual void SaveSettings() = 0;

    /** Creates or updates a module with <i>name</i> and <i>params</i> */
    virtual void Module(const QString name, const QStringList params) = 0;

    /** Returns list of loaded module names */
    virtual QStringList ModuleList() const = 0;

    /** Returns a Channel Pointer for connect signals/slots */
    virtual BBoB_Channel* ChannelPointer(const QString mod, const QString input) const = 0;

    /** Returns a Module Pointer for access to params */
    virtual BBoB_Module* ModulePointer(const QString mod) const = 0;

    /** Returns a QMap of parameters and values */
    virtual QMap<QString, QString> ModuleParams(const QString name) const = 0;

    /** Returns a QMap of inputs or outputs available for each module, with mime type */
    virtual QMap<QString, QString> ModuleInputs(const QString name) const = 0;
    virtual QMap<QString, QString> ModuleOutputs(const QString name) const = 0;
};



/// Interface to return a QDockWidget with a QDialog.
class DisplayInterface
{
public:
    virtual ~DisplayInterface() {}

    /* Commands list for plugin menu */
    virtual QStringList commands() const = 0;

    /* Displayable widget */
    virtual QDockWidget* getDock(const QString &command) = 0;

    /* ConfigTab widget */
    virtual QWidget* getConfig() = 0;

};


///Interface to setup "Message Bus" widgets
class MessageBusInterface
{
public:
    virtual ~MessageBusInterface() {}

    /* Initialize BusID */
    virtual bool loadBus(const int ID) = 0;
    virtual QString BusName() = 0;

    /* Busses pass data between plugins and is routed through BCore */
    virtual void BitBus(const int FromID, const int bit ) = 0;
    virtual void ByteBus(const int FromID, const int byte ) = 0;
    virtual void StringBus(const int FromID, const QString str ) = 0;

};



Q_DECLARE_INTERFACE(CoreInterface,
                    "net.chuktech.BBoB.CoreInterface/1.0")

Q_DECLARE_INTERFACE(DisplayInterface,
                    "net.chuktech.BBoB.DisplayInterface/1.0")

Q_DECLARE_INTERFACE(MessageBusInterface,
                    "net.chuktech.BBoB.MessageBusInterface/1.0")
#endif

---