WSCOVISEClient.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 WSCOVISECLIENT_H
#define WSCOVISECLIENT_H
 
#include <QList>
#include <QMap>
#include <QMutex>
#include <QObject>
#include <QQueue>
#include <QString>
#include <QStringList>
#include <QThread>
 
#include "WSExport.h"
 
namespace covise
{
 
class WSMap;
class WSModule;
class WSParameter;
class covise__Event;
 
class COVISEProxy;
 
class WSLIBEXPORT WSCOVISEClient : public QThread
{
 
    Q_OBJECT
    Q_DISABLE_COPY(WSCOVISEClient)
 
    Q_PROPERTY(WSMap *map READ getMap)
    Q_PROPERTY(QString endpoint READ getEndpoint)
    Q_PROPERTY(bool inExecute READ isInExecute)
 
public:
    WSCOVISEClient();
    virtual ~WSCOVISEClient();
 
public slots:
    bool attach(const QString &endpoint = "http://localhost:31111/");
 
    bool detach();
 
    const QString &getEndpoint() const
    {
        return this->endpoint;
    }
 
    bool isInExecute() const;
 
    void setEventsAsSignal(bool on, bool alsoQueueRaw = false);
 
    void setReadOnly(bool ro);
    bool isReadOnly() const;
 
    WSMap *getMap() const;
 
    WSModule *getModule(const QString &name, const QString &host) const;
 
    QList<WSModule *> getModules(const QString &host) const;
 
    QStringList getHosts() const;
 
    void executeNet();
 
    void executeModule(const QString &moduleID);
 
    void setParameterFromString(const QString &moduleID, const QString &parameter, const QString &value);
 
    QString getParameterAsString(const QString &moduleID, const QString &parameter);
 
    void instantiateModule(const QString &module, const QString &host);
 
    void deleteModule(const QString &moduleID);
 
    void link(const QString &fromModuleID, const QString &fromPort, const QString &toModuleID, const QString &toPort);
    void unlink(const QString &linkID);
 
    void openNet(const QString &filename);
 
    void quit();
 
    covise::covise__Event *takeEvent();
 
signals:
    void eventLink(const QString &fromModuleID, const QString &toModuleID);
    void eventUnlink(const QString &linkID);
    void eventModuleAdd(const QString &moduleID);
    void eventModuleDel(const QString &moduleID);
    void eventModuleDied(const QString &moduleID);
    void eventModuleChanged(const QString &moduleID);
    void eventModuleExecuteStart(const QString &moduleID);
    void eventModuleExecuteFinish(const QString &moduleID);
    void eventExecuteStart();
    void eventExecuteFinish();
 
    void eventParameterChanged(const QString &moduleID, const QString &name, const QString &value);
    void eventOpenNet(const QString &mapname);
    void eventOpenNetDone(const QString &mapname);
    void eventQuit();
 
private slots:
    void parameterChangeCB(covise::WSParameter *);
 
private:
    void clearAvailableModules();
 
    virtual void run();
 
    // Contains a map of the host and the modules available on that host
    QMap<QString, QList<covise::WSModule *> > availableModules;
    // The loaded modules
    covise::WSMap *map;
 
    QString endpoint;
    bool attached;
 
    bool keepRunning;
 
    QString eventUUID;
 
    QQueue<covise::covise__Event *> eventQueue;
    QMutex eventQueueLock;
 
    bool eventsAsSignal;
    bool alsoQueueRaw;
 
    bool readOnly;
    bool inExecute;
};
}
 
#endif // WSCOVISECLIENT_H