KSysGuard::SensorDataModel

KSysGuard
SensorDataModel

#include <SensorDataModel.h>

Inheritance diagram for KSysGuard::SensorDataModel:

[legend]

Public Types
enum	AdditionalRoles { SensorId = Qt::UserRole + 1 , Name , ShortName , Description , Unit , Minimum , Maximum , Type , Value , FormattedValue , Color , UpdateInterval }

Public Types inherited from QAbstractItemModel
enum	CheckIndexOption

typedef	CheckIndexOptions

enum	LayoutChangeHint

Public Types inherited from QObject
typedef	QObjectList

Properties
bool	enabled

qreal	maximum

qreal	minimum

bool	ready

QVariantMap	sensorColors

QVariantMap	sensorLabels

QML_ELEMENTQStringList	sensors

int	updateRateLimit

Properties inherited from QObject
	objectName

Public Member Functions
	SensorDataModel (const QStringList &sensorIds={}, QObject *parent=nullptr)

Q_INVOKABLE void	addSensor (const QString &sensorId)

void	classBegin () override

Q_INVOKABLE int	column (const QString &sensorId) const

int	columnCount (const QModelIndex &parent=QModelIndex()) const override

void	componentComplete () override

QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override

bool	enabled () const

Q_SIGNAL void	enabledChanged ()

QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override

bool	isReady () const

qreal	maximum () const

qreal	minimum () const

Q_SIGNAL void	readyChanged ()

Q_INVOKABLE void	removeSensor (const QString &sensorId)

void	resetUpdateRateLimit ()

QHash< int, QByteArray >	roleNames () const override

int	rowCount (const QModelIndex &parent=QModelIndex()) const override

QVariantMap	sensorColors () const

Q_SIGNAL void	sensorColorsChanged ()

QVariantMap	sensorLabels () const

Q_SIGNAL void	sensorLabelsChanged ()

Q_SIGNAL void	sensorMetaDataChanged ()

QStringList	sensors () const

Q_SIGNAL void	sensorsChanged () const

void	setEnabled (bool newEnabled)

void	setSensorColors (const QVariantMap &sensorColors)

void	setSensorLabels (const QVariantMap &sensorLabels)

void	setSensors (const QStringList &sensorIds)

void	setUpdateRateLimit (int newUpdateRateLimit)

int	updateRateLimit () const

Q_SIGNAL void	updateRateLimitChanged ()

Public Member Functions inherited from QAbstractTableModel
	QAbstractTableModel (QObject *parent)

virtual bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override

virtual Qt::ItemFlags	flags (const QModelIndex &index) const const override

virtual QModelIndex	index (int row, int column, const QModelIndex &parent) const const override

virtual QModelIndex	sibling (int row, int column, const QModelIndex &idx) const const override

Public Member Functions inherited from QAbstractItemModel
	QAbstractItemModel (QObject *parent)

virtual QModelIndex	buddy (const QModelIndex &index) const const

virtual bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const const

virtual bool	canFetchMore (const QModelIndex &parent) const const

bool	checkIndex (const QModelIndex &index, CheckIndexOptions options) const const

virtual bool	clearItemData (const QModelIndex &index)

void	columnsAboutToBeInserted (const QModelIndex &parent, int first, int last)

void	columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)

void	columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last)

void	columnsInserted (const QModelIndex &parent, int first, int last)

void	columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)

void	columnsRemoved (const QModelIndex &parent, int first, int last)

void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles)

virtual void	fetchMore (const QModelIndex &parent)

virtual bool	hasChildren (const QModelIndex &parent) const const

bool	hasIndex (int row, int column, const QModelIndex &parent) const const

void	headerDataChanged (Qt::Orientation orientation, int first, int last)

bool	insertColumn (int column, const QModelIndex &parent)

virtual bool	insertColumns (int column, int count, const QModelIndex &parent)

bool	insertRow (int row, const QModelIndex &parent)

virtual bool	insertRows (int row, int count, const QModelIndex &parent)

virtual QMap< int, QVariant >	itemData (const QModelIndex &index) const const

void	layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)

void	layoutChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)

virtual QModelIndexList	match (const QModelIndex &start, int role, const QVariant &value, int hits, Qt::MatchFlags flags) const const

virtual QMimeData *	mimeData (const QModelIndexList &indexes) const const

virtual QStringList	mimeTypes () const const

void	modelAboutToBeReset ()

void	modelReset ()

bool	moveColumn (const QModelIndex &sourceParent, int sourceColumn, const QModelIndex &destinationParent, int destinationChild)

virtual bool	moveColumns (const QModelIndex &sourceParent, int sourceColumn, int count, const QModelIndex &destinationParent, int destinationChild)

bool	moveRow (const QModelIndex &sourceParent, int sourceRow, const QModelIndex &destinationParent, int destinationChild)

virtual bool	moveRows (const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild)

virtual void	multiData (const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const const

virtual QModelIndex	parent (const QModelIndex &index) const const=0

bool	removeColumn (int column, const QModelIndex &parent)

virtual bool	removeColumns (int column, int count, const QModelIndex &parent)

bool	removeRow (int row, const QModelIndex &parent)

virtual bool	removeRows (int row, int count, const QModelIndex &parent)

virtual void	revert ()

void	rowsAboutToBeInserted (const QModelIndex &parent, int start, int end)

void	rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)

void	rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last)

void	rowsInserted (const QModelIndex &parent, int first, int last)

void	rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)

void	rowsRemoved (const QModelIndex &parent, int first, int last)

virtual bool	setData (const QModelIndex &index, const QVariant &value, int role)

virtual bool	setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role)

virtual bool	setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)

virtual void	sort (int column, Qt::SortOrder order)

virtual QSize	span (const QModelIndex &index) const const

virtual bool	submit ()

virtual Qt::DropActions	supportedDragActions () const const

virtual Qt::DropActions	supportedDropActions () const const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Public Member Functions inherited from QQmlParserStatus

Additional Inherited Members
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QAbstractItemModel
	DoNotUseParent

	HorizontalSortHint

	IndexIsValid

	NoLayoutChangeHint

	NoOption

	ParentIsInvalid

	VerticalSortHint

Protected Member Functions inherited from QAbstractItemModel
void	beginInsertColumns (const QModelIndex &parent, int first, int last)

void	beginInsertRows (const QModelIndex &parent, int first, int last)

bool	beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)

bool	beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)

void	beginRemoveColumns (const QModelIndex &parent, int first, int last)

void	beginRemoveRows (const QModelIndex &parent, int first, int last)

void	beginResetModel ()

void	changePersistentIndex (const QModelIndex &from, const QModelIndex &to)

void	changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)

QModelIndex	createIndex (int row, int column, const void *ptr) const const

QModelIndex	createIndex (int row, int column, quintptr id) const const

void	endInsertColumns ()

void	endInsertRows ()

void	endMoveColumns ()

void	endMoveRows ()

void	endRemoveColumns ()

void	endRemoveRows ()

void	endResetModel ()

QModelIndexList	persistentIndexList () const const

virtual void	resetInternalData ()

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Detailed Description

A model representing a table of sensors.

This model will expose the metadata and values of a list of sensors as a table, using one column for each sensor. The metadata and values are represented as different roles.

Definition at line 28 of file SensorDataModel.h.

Member Enumeration Documentation

◆ AdditionalRoles

enum KSysGuard::SensorDataModel::AdditionalRoles

The roles that this model exposes.

See also: Sensor

Enumerator
SensorId	The backend path to the sensor.
Name	The name of the sensor.
ShortName	A shorter name for the sensor. This is equal to name if not set.
Description	A description for the sensor.
Unit	The unit of the sensor.
Minimum	The minimum value this sensor can have.
Maximum	The maximum value this sensor can have.
Type	The QVariant::Type of the sensor.
Value	The value of the sensor.
FormattedValue	A formatted string of the value of the sensor.
Color	A color of the sensor, if sensorColors is set.
UpdateInterval	The time in milliseconds between each update of the sensor.

Definition at line 83 of file SensorDataModel.h.

Property Documentation

◆ enabled

bool KSysGuard::SensorDataModel::enabled

readwrite

Should this model be updated or not.

Defaults to true.

Definition at line 49 of file SensorDataModel.h.

◆ maximum

qreal KSysGuard::SensorDataModel::maximum

read

The maximum value of all sensors' maximum property.

Definition at line 45 of file SensorDataModel.h.

◆ minimum

qreal KSysGuard::SensorDataModel::minimum

read

The minimum value of all sensors' minimum property.

Definition at line 41 of file SensorDataModel.h.

◆ ready

bool KSysGuard::SensorDataModel::ready

read

Is this model ready?

Ready means it has retrieved the metadata for the sensors specified in sensors.

Definition at line 56 of file SensorDataModel.h.

◆ sensorColors

QVariantMap KSysGuard::SensorDataModel::sensorColors

readwrite

Used by the model to provide data for the Color role if set.

Definition at line 61 of file SensorDataModel.h.

◆ sensorLabels

QVariantMap KSysGuard::SensorDataModel::sensorLabels

readwrite

Provides custom labels for Sensors that are used instead of the name and short name of the sensors.

Definition at line 66 of file SensorDataModel.h.

◆ sensors

QML_ELEMENTQStringList KSysGuard::SensorDataModel::sensors

readwrite

The list of sensors to watch.

Definition at line 37 of file SensorDataModel.h.

◆ updateRateLimit

int KSysGuard::SensorDataModel::updateRateLimit

readwrite

The minimum time between updates, in milliseconds.

If this is set to a positive non-zero value, at least this many milliseconds need to elapse before another value update happens, otherwise it is ignored. This effectively rate-limits the updates and will prevent value updates.

Definition at line 76 of file SensorDataModel.h.

Constructor & Destructor Documentation

◆ SensorDataModel()

SensorDataModel::SensorDataModel	(	const QStringList &	sensorIds = {},
		QObject *	parent = nullptr )

explicit

Definition at line 62 of file SensorDataModel.cpp.

◆ ~SensorDataModel()

SensorDataModel::~SensorDataModel ( )

override

Definition at line 77 of file SensorDataModel.cpp.

Member Function Documentation

◆ addSensor()

void SensorDataModel::addSensor ( const QString & sensorId )

Definition at line 362 of file SensorDataModel.cpp.

◆ classBegin()

void KSysGuard::SensorDataModel::classBegin ( )

overridevirtual

Implements QQmlParserStatus.

Definition at line 377 of file SensorDataModel.cpp.

◆ column()

int KSysGuard::SensorDataModel::column ( const QString & sensorId ) const

Definition at line 372 of file SensorDataModel.cpp.

◆ columnCount()

int SensorDataModel::columnCount ( const QModelIndex & parent = QModelIndex() ) const

overridevirtual

Implements QAbstractItemModel.

Definition at line 203 of file SensorDataModel.cpp.

◆ componentComplete()

void KSysGuard::SensorDataModel::componentComplete ( )

overridevirtual

Implements QQmlParserStatus.

Definition at line 382 of file SensorDataModel.cpp.

◆ data()

QVariant SensorDataModel::data	(	const QModelIndex &	index,
		int	role = Qt::DisplayRole ) const

overridevirtual

Implements QAbstractItemModel.

Definition at line 94 of file SensorDataModel.cpp.

◆ enabled()

bool SensorDataModel::enabled ( ) const

Definition at line 274 of file SensorDataModel.cpp.

◆ headerData()

QVariant SensorDataModel::headerData	(	int	section,
		Qt::Orientation	orientation,
		int	role = Qt::DisplayRole ) const

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 150 of file SensorDataModel.cpp.

◆ isReady()

bool KSysGuard::SensorDataModel::isReady ( ) const

Definition at line 357 of file SensorDataModel.cpp.

◆ maximum()

qreal SensorDataModel::maximum ( ) const

Definition at line 233 of file SensorDataModel.cpp.

◆ minimum()

qreal SensorDataModel::minimum ( ) const

Definition at line 212 of file SensorDataModel.cpp.

◆ removeSensor()

void SensorDataModel::removeSensor ( const QString & sensorId )

Definition at line 367 of file SensorDataModel.cpp.

◆ resetUpdateRateLimit()

void KSysGuard::SensorDataModel::resetUpdateRateLimit ( )

Definition at line 352 of file SensorDataModel.cpp.

◆ roleNames()

QHash< int, QByteArray > SensorDataModel::roleNames ( ) const

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 81 of file SensorDataModel.cpp.

◆ rowCount()

int SensorDataModel::rowCount ( const QModelIndex & parent = QModelIndex() ) const

overridevirtual

Implements QAbstractItemModel.

Definition at line 194 of file SensorDataModel.cpp.

◆ sensorColors()

QVariantMap SensorDataModel::sensorColors ( ) const

Definition at line 296 of file SensorDataModel.cpp.

◆ sensorLabels()

QVariantMap SensorDataModel::sensorLabels ( ) const

Definition at line 311 of file SensorDataModel.cpp.

◆ sensors()

QStringList SensorDataModel::sensors ( ) const

Definition at line 254 of file SensorDataModel.cpp.

◆ setEnabled()

void SensorDataModel::setEnabled ( bool newEnabled )

Definition at line 279 of file SensorDataModel.cpp.

◆ setSensorColors()

void SensorDataModel::setSensorColors ( const QVariantMap & sensorColors )

Definition at line 301 of file SensorDataModel.cpp.

◆ setSensorLabels()

void SensorDataModel::setSensorLabels ( const QVariantMap & sensorLabels )

Definition at line 316 of file SensorDataModel.cpp.

◆ setSensors()

void SensorDataModel::setSensors ( const QStringList & sensorIds )

Definition at line 259 of file SensorDataModel.cpp.

◆ setUpdateRateLimit()

void SensorDataModel::setUpdateRateLimit ( int newUpdateRateLimit )

Definition at line 331 of file SensorDataModel.cpp.

◆ updateRateLimit()

int SensorDataModel::updateRateLimit ( ) const

Definition at line 326 of file SensorDataModel.cpp.

The documentation for this class was generated from the following files:

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Libksysguard

KSysGuard::SensorDataModel

Public Types

Properties

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ AdditionalRoles

Property Documentation

◆ enabled

◆ maximum

◆ minimum

◆ ready

◆ sensorColors

◆ sensorLabels

◆ sensors

◆ updateRateLimit

Constructor & Destructor Documentation

◆ SensorDataModel()

◆ ~SensorDataModel()

Member Function Documentation

◆ addSensor()

◆ classBegin()

◆ column()

◆ columnCount()

◆ componentComplete()

◆ data()

◆ enabled()

◆ headerData()

◆ isReady()

◆ maximum()

◆ minimum()

◆ removeSensor()

◆ resetUpdateRateLimit()

◆ roleNames()

◆ rowCount()

◆ sensorColors()

◆ sensorLabels()

◆ sensors()

◆ setEnabled()

◆ setSensorColors()

◆ setSensorLabels()

◆ setSensors()

◆ setUpdateRateLimit()

◆ updateRateLimit()