WSModule.h

Go to the documentation of this file.

/* This file is part of COVISE.

   You can use it under the terms of the GNU Lesser General Public License
   version 2.1 or later, see lgpl-2.1.txt.

 * License: LGPL 2+ */

#ifndef WSMODULE_H
#define WSMODULE_H

#include "WSExport.h"
#include "WSParameter.h"
#include "WSPort.h"

#include "WSCoviseStub.h"

#include <QPoint>
#include <QObject>

namespace covise
{

class WSLIBEXPORT WSModule : public QObject
{

    Q_OBJECT

    Q_PROPERTY(QString name READ getName)
    Q_PROPERTY(QString id READ getID)
    Q_PROPERTY(QString host READ getHost)
    Q_PROPERTY(QString description READ getDescription)
    Q_PROPERTY(QString category READ getCategory)
    Q_PROPERTY(QString title READ getTitle WRITE setTitle)
    Q_PROPERTY(QString instance READ getInstance)
    Q_PROPERTY(bool dead READ isDead)

public:
    WSModule(const QString &name, const QString &category, const QString &host);
    explicit WSModule(const covise::covise__Module &module);
    ~WSModule();

    WSPort *addInputPort(const QString &inName, const QStringList &inTypes, WSPort::PortType inPortType = WSPort::Default);

    WSPort *addOutputPort(const QString &name, const QStringList &types, WSPort::PortType portType = WSPort::Default);

    WSParameter *addParameter(const QString &name, const QString &type, const QString &description);

    WSPort *getOutputPort(const QString &name) const;
    WSPort *getInputPort(const QString &name) const;

    const QMap<QString, WSPort *> &getInputPorts() const
    {
        return this->inputPorts;
    }

    const QMap<QString, WSPort *> &getOutputPorts() const
    {
        return this->outputPorts;
    }

    const QMap<QString, WSParameter *> &getParameters() const
    {
        return this->parameters;
    }

signals:
    void changed();
    void parameterChanged(covise::WSParameter *);
    void died();
    void deleted(const QString &moduleID);

public slots:

    // All return values have to be by value for the scripting interface to function

    QString getHost() const
    {
        return this->host;
    }

    QString getName() const
    {
        return this->name;
    }

    QString getID() const
    {
        return this->id;
    }

    QString getDescription() const
    {
        return this->description;
    }

    QString getCategory() const
    {
        return this->category;
    }

    void setTitle(const QString &title);

    QString getTitle() const
    {
        return this->title;
    }

    WSParameter *getParameter(const QString &name) const;

    QPoint getPosition() const
    {
        return this->position;
    }

    void setPosition(int x, int y)
    {
        this->position.setX(x);
        this->position.setY(y);
        emit changed();
    }

    QString getInstance() const
    {
        return this->instance;
    }

    QStringList getParameterNames() const;

    bool isDead() const
    {
        return this->dead;
    }

public:
    virtual covise::covise__Module getSerialisable() const;
    void setFromSerialisable(const covise::covise__Module &serialisable);

    void instantiate(const QString &host, const QString &instance);

    void setID(const QString &id)
    {
        this->id = id;
        emit changed();
    }

    void setCategory(const QString &category)
    {
        this->category = category;
        emit changed();
    }

    void setDescription(const QString &description)
    {
        this->description = description;
        emit changed();
    }

    void setDead(bool dead);

private slots:
    void parameterChangedCB(covise::WSParameter *);

private:
    // Name of module
    QString name;
    // ID of a (running) module
    QString id;
    // Host the module is running on, may be empty
    QString host;
    // Description of module
    QString description;
    // Category of module
    QString category;
    // Module title
    QString title;
    // Module instance
    QString instance;
    // Parameters of the module with name of each parameter
    QMap<QString, WSParameter *> parameters;
    // Input ports of the module with name of each port
    QMap<QString, WSPort *> inputPorts;
    // Output ports of the module with name of each port
    QMap<QString, WSPort *> outputPorts;

    // Position of the module on the canvas
    QPoint position;

    bool dead;
};
}
#endif // WSMODULE_H