WSParameter.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 WSPARAMETER_H
#define WSPARAMETER_H

#include <QString>
#include <QStringList>
#include <QVector>
#include <QMap>
#include <QVariant>

#include <map>

#include "WSExport.h"
#include "WSCoviseStub.h"

#include <QObject>

namespace covise
{

class WSLIBEXPORT WSParameter : public QObject
{

    Q_OBJECT

    Q_PROPERTY(QString name READ getName)
    Q_PROPERTY(QString type READ getType)
    Q_PROPERTY(QString description READ getDescription)
    Q_PROPERTY(bool enabled READ isEnabled WRITE setEnabled)
    Q_PROPERTY(bool mapped READ isMapped WRITE setMapped)

public:
    WSParameter(const QString &name, const QString &description, const QString &type);
    virtual ~WSParameter();

signals:
    void parameterChanged(covise::WSParameter *parameter);

public slots:
    const QString &getName() const
    {
        return this->name;
    }

    const QString &getType() const
    {
        return this->type;
    }

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

    void setEnabled(bool state)
    {
        this->enabled = state;
    }

    bool isEnabled() const
    {
        return this->enabled;
    }

    void setMapped(bool mapped)
    {
        this->mapped = mapped;
    }

    bool isMapped() const
    {
        return this->mapped;
    }

    virtual int getComponentCount() const;

    virtual QString toString() const = 0;

    virtual WSParameter *clone() const = 0;

    virtual const covise::covise__Parameter *getSerialisable() = 0;

    virtual bool setValueFromSerialisable(const covise::covise__Parameter *serialisable) = 0;

    virtual QString toCoviseString() const
    {
        QString value = toString();
        if (value == "")
            return QChar('\177');
        else
            return value;
    }

    static WSParameter *create(covise::covise__Parameter *parameter);

protected:
    const covise::covise__Parameter *getSerialisable(covise::covise__Parameter *parameter) const;

    static WSParameter *addPrototype(QString className, WSParameter *prototype)
    {
        static std::map<QString, WSParameter *> *p = new std::map<QString, WSParameter *>();
        //std::cerr << "WSParameter::addPrototype info: adding " << qPrintable(className) << std::endl;
        (*p)[className] = prototype;
        prototypes = p;
        return prototype;
    }

    bool equals(const covise::covise__Parameter *, const covise::covise__Parameter *);

protected:
    WSParameter(const WSParameter &);

private:
    // Name of the parameter
    QString name;
    // Type of the parameter
    QString type;
    // Description of the parameter
    QString description;

    bool enabled;
    bool mapped;

    static std::map<QString, WSParameter *> *prototypes;

    void setName(const QString &inName)
    {
        this->name = inName;
    }

    void setType(const QString &inType)
    {
        this->type = inType;
    }

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

#endif // WSPARAMETER_H