Differential D28141 Diff 78275 sensors/SensorDataModel.h

Changeset View

Standalone View

sensors/SensorDataModel.h

This file was added.

		1		/*
		2		Copyright (c) 2019 Eike Hein <hein@kde.org>
		3		Copyright (C) 2020 Arjen Hiemstra <ahiemstra@heimr.nl>
		4
		5		This library is free software; you can redistribute it and/or
		6		modify it under the terms of the GNU Library General Public
		7		License as published by the Free Software Foundation; either
		8		version 2 of the License, or (at your option) any later version.
		9
		10		This library is distributed in the hope that it will be useful,
		11		but WITHOUT ANY WARRANTY; without even the implied warranty of
		12		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
		13		Library General Public License for more details.
		14
		15		You should have received a copy of the GNU Library General Public License
		16		along with this library; see the file COPYING.LIB. If not, write to
		17		the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
		18		Boston, MA 02110-1301, USA.
		19		*/
		20
		21		#pragma once
		22
		23		#include <memory>
		24		#include <QAbstractTableModel>
		25		#include <QQmlParserStatus>
		26		#include <QDateTime>
		27		#include "sensors_export.h"
		28
		29		namespace KSysGuard
		30		{
		31
		32		class SensorInfo;
		33
		34		/**
		35		* A model representing a table of sensors.
		36		*
		37		* This model will expose the metadata and values of a list of sensors as a
		38		* table, using one column for each sensor. The metadata and values are
		39		* represented as different roles.
		40		*/
		41		class SENSORS_EXPORT SensorDataModel : public QAbstractTableModel, public QQmlParserStatus
		42		{
		43		Q_OBJECT
		44		Q_INTERFACES(QQmlParserStatus)
		45
		46		/**
		47		* The list of sensors to watch.
		48		*/
		49		Q_PROPERTY(QStringList sensors READ sensors WRITE setSensors NOTIFY sensorsChanged)
		50		/**
		51		* The minimum value of all sensors' minimum property.
		52		*/
		53		Q_PROPERTY(qreal minimum READ minimum NOTIFY sensorMetaDataChanged)
		54		/**
		55		* The maximum value of all sensors' maximum property.
		56		*/
		57		Q_PROPERTY(qreal maximum READ maximum NOTIFY sensorMetaDataChanged)
		58
		59		public:
		60		enum AdditionalRoles {
		61		SensorId = Qt::UserRole + 1, //< The backend path to the sensor.
		62		Name, //< The name of the sensor.
		63		ShortName, //< A shorter name for the sensor. This is equal to name if not set.
		64		Description, //< A description for the sensor.
		65		Unit, //< The unit of the sensor.
		66		Minimum, //< The minimum value this sensor can have.
		67		Maximum, //< The maximum value this sensor can have.
		68		Type, //< The QVariant::Type of the sensor.
		69		Value, //< The value of the sensor.
		70		FormattedValue, //< A formatted string of the value of the sensor.
		71		};
		72		Q_ENUM(AdditionalRoles)
		73
		74		explicit SensorDataModel(const QStringList &sensorIds = {}, QObject *parent = nullptr);
		75		virtual ~SensorDataModel();
		76
		77		QHash<int, QByteArray> roleNames() const override;
		78
		79		QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
		80		QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override;
		81
		82		int rowCount(const QModelIndex &parent = QModelIndex()) const override;
		83		int columnCount(const QModelIndex &parent = QModelIndex()) const override;
		84
		85		QStringList sensors() const;
		86		void setSensors(const QStringList &sensorIds);
		87		Q_SIGNAL void sensorsChanged() const;
		88		Q_SIGNAL void sensorMetaDataChanged();
		89
		90		qreal minimum() const;
		91		qreal maximum() const;
		92
		93		Q_INVOKABLE void addSensor(const QString &sensorId);
		94		Q_INVOKABLE void removeSensor(const QString &sensorId);
		95		Q_INVOKABLE int column(const QString &sensorId) const;
		96
		97		void classBegin() override;
		98		void componentComplete() override;
		99
		100		private:
		101		void onSensorAdded(const QString &sensorId);
		102		void onSensorRemoved(const QString &sensorId);
		103		void onMetaDataChanged(const QString &sensorId, const SensorInfo &info);
		104		void onValueChanged(const QString &sensorId, const QVariant &value);
		105
		106		class Private;
		107		const std::unique_ptr<Private> d;
		108		};
		109
		110		} // namespace KSysGuard