notificationitem.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, see <http://www.gnu.org/licenses/>
 */

#ifndef NOTIFICATION_ITEM_H
#define NOTIFICATION_ITEM_H

#include <coreplugin/iuavgadgetconfiguration.h>
#include "qsettings.h"
#include <qstringlist.h>
#include <QTimer>

using namespace Core;

#define DECLARE_SOUND(number)                                                                      \
    QString getSound##number() const { return _sound##number; }                                    \
    void setSound##number(QString text) { _sound##number = text; }

class UAVDataObject;
class UAVObjectField;

class NotificationItem : public QObject
{
    Q_OBJECT
public:
    enum { eDefaultTimeout = 15 }; // in sec

    enum { never, beforeFirst, beforeSecond, afterSecond };
    enum {
        repeatOncePerUpdate,
        repeatOnce,
        repeatInstantly,
        repeat10seconds,
        repeat30seconds,
        repeat1minute
    };

    explicit NotificationItem(QObject *parent = nullptr);

    void copyTo(NotificationItem *) const;

    DECLARE_SOUND(1)
    DECLARE_SOUND(2)
    DECLARE_SOUND(3)

    bool getCurrentUpdatePlayed() const { return _currentUpdatePlayed; }
    void setCurrentUpdatePlayed(bool value) { _currentUpdatePlayed = value; }

    int getCondition() const { return _condition; }
    void setCondition(int value) { _condition = value; }

    int getSayOrder() const { return _sayOrder; }
    void setSayOrder(int text) { _sayOrder = text; }

    QVariant singleValue() const { return _singleValue; }
    void setSingleValue(QVariant value) { _singleValue = value; }

    double valueRange2() const { return _valueRange2; }
    void setValueRange2(double value) { _valueRange2 = value; }

    QString getDataObject() const { return _dataObject; }
    void setDataObject(QString text) { _dataObject = text; }

    QString getObjectField() const { return _objectField; }
    void setObjectField(QString text) { _objectField = text; }

    QString getSoundCollectionPath() const { return _soundCollectionPath; }
    void setSoundCollectionPath(QString path) { _soundCollectionPath = path; }

    QString getCurrentLanguage() const { return _currentLanguage; }
    void setCurrentLanguage(QString text) { _currentLanguage = text; }

    QStringList getMessageSequence() const { return _messageSequence; }
    void setMessageSequence(QStringList sequence) { _messageSequence = sequence; }

    int retryValue() const { return _repeatValue; }
    void setRetryValue(int value) { _repeatValue = value; }

    int lifetime() const { return _expireTimeout; }
    void setLifetime(int value) { _expireTimeout = value; }

    bool mute() const { return _mute; }
    void setMute(bool value) { _mute = value; }

    void saveState(QSettings *settings) const;
    void restoreState(QSettings *settings);

    UAVDataObject *getUAVObject(void);
    UAVObjectField *getUAVObjectField(void);

    void serialize(QDataStream &stream);
    void deserialize(QDataStream &stream);

    QString toString();

    QStringList &toSoundList();

    QString getSoundCaption(QString fileName);

    QTimer *getTimer() const { return _timer; }
    void startTimer(int value);
    void restartTimer();
    void stopTimer();
    void disposeTimer();

    QTimer *getExpireTimer() const { return _expireTimer; }
    void startExpireTimer();
    void stopExpireTimer();

    void disposeExpireTimer();

    bool isNowPlaying;
    bool _isPlayed;

    static QStringList sayOrderValues;
    static QStringList retryValues;

private:
    QString checkSoundExists(QString fileName);

private:
    bool _currentUpdatePlayed;

    QTimer *_timer;

    QTimer *_expireTimer;

    QStringList _messageSequence;

    QString _soundCollectionPath;

    QString _currentLanguage;

    QString _dataObject;

    QString _objectField;

    int _condition;

    QString _sound1;
    QString _sound2;
    QString _sound3;

    int _sayOrder;

    QVariant _singleValue;

    // double _valueRange1;
    double _valueRange2;

    int _repeatValue;

    int _expireTimeout;

    bool _mute;
};

Q_DECLARE_METATYPE(NotificationItem *)

#endif // NotificationItem_H