HistoryProxySource

Search for usage in LXR

HistoryProxySource Class Reference

#include <HistoryProxySource.h>

Inheritance diagram for HistoryProxySource:

Public Types

enum  FillMode { DoNotFill , FillFromStart , FillFromEnd }
 
- Public Types inherited from QObject
typedef  QObjectList
 

Properties

FillMode fillMode
 
int interval
 
int item
 
int maximumHistory
 
ChartDataSourcesource
 
- Properties inherited from QObject
 objectName
 

Public Member Functions

 HistoryProxySource (QObject *parent=nullptr)
 
Q_INVOKABLE void clear ()
 
FillMode fillMode () const
 
Q_SIGNAL void fillModeChanged ()
 
QVariant first () const override
 
int interval () const
 
Q_SIGNAL void intervalChanged ()
 
int item () const
 
QVariant item (int index) const override
 
Q_SIGNAL void itemChanged ()
 
int itemCount () const override
 
QVariant maximum () const override
 
int maximumHistory () const
 
Q_SIGNAL void maximumHistoryChanged ()
 
QVariant minimum () const override
 
void setFillMode (FillMode newFillMode)
 
void setInterval (int newInterval)
 
void setItem (int newItem)
 
void setMaximumHistory (int maximumHistory)
 
void setSource (ChartDataSource *newSource)
 
ChartDataSourcesource () const
 
Q_SIGNAL void sourceChanged ()
 
- Public Member Functions inherited from ChartDataSource
 ChartDataSource (QObject *parent=nullptr)
 
Q_SIGNAL void dataChanged ()
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QStringbindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
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 QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () 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
 
qobject_cast (const QObject *object)
 
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)
 
QThreadthread () const const
 

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)
 
- 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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from ChartDataSource
static bool variantCompare (const QVariant &lhs, const QVariant &rhs)
 

Detailed Description

A data source that provides a history of a single item of a different data source.

This data source will monitor a single item of another data source for changes and record them, exposing historical values as

Definition at line 24 of file HistoryProxySource.h.

Member Enumeration Documentation

◆ FillMode

The different fill modes.

These determine the value returned by itemCount and what happens when requesting an item that does not have a value in the history.

Enumerator
DoNotFill 

Do not fill with any items.

The source's itemCount will be equal to the number of items in the history.

FillFromStart 

Fill with empty values, starting at 0.

The source's itemCount will be equal to maximumHistory. Items that do not have a value in the history will return a default-constructed value based on the first item of the source.

FillFromEnd 

Fill with empty values, placing partial history at the end.

This means that the first recorded history item will be shown at position maximumHistory - 1, the second at maximumHistory - 2 and so on, until maximumHistory is reached, after which items will be discarded normally.

Definition at line 36 of file HistoryProxySource.h.

Property Documentation

◆ fillMode

FillMode HistoryProxySource::fillMode
readwrite

The fill mode.

This determines what happens when there is not enough history yet. See FillMode for which modes are available.

The default is DoNotFill.

Note
Changing this property will clear the existing history.

Definition at line 121 of file HistoryProxySource.h.

◆ interval

int HistoryProxySource::interval
readwrite

The interval, in milliseconds, with which to query the data source.

If set to a value <= 0, a new item will be added whenever source changes. Otherwise, source will be sampled every interval milliseconds and a new item will be added with whatever value it has at that point, even if it did not change.

The default is 0.

Definition at line 107 of file HistoryProxySource.h.

◆ item

int HistoryProxySource::item
readwrite

The item of the data source to read data from.

This item will be read either when the source's dataChanged has been emitted or on an interval if interval has been set.

The default is 0.

Note
Changing this property will clear the existing history.

Definition at line 84 of file HistoryProxySource.h.

◆ maximumHistory

int HistoryProxySource::maximumHistory
readwrite

The maximum amount of history to keep.

The default is 10.

Definition at line 93 of file HistoryProxySource.h.

◆ source

ChartDataSource * HistoryProxySource::source
readwrite

The data source to read data from.

This will use the item at item from the provided source and use that to fill the history of this source.

Note
Changing this property will clear the existing history.

Definition at line 70 of file HistoryProxySource.h.

Constructor & Destructor Documentation

◆ HistoryProxySource()

HistoryProxySource::HistoryProxySource ( QObject * parent = nullptr)
explicit

Definition at line 12 of file HistoryProxySource.cpp.

Member Function Documentation

◆ clear()

void HistoryProxySource::clear ( )

Clear the entire history of this source.

Definition at line 209 of file HistoryProxySource.cpp.

◆ fillMode()

HistoryProxySource::FillMode HistoryProxySource::fillMode ( ) const

Definition at line 193 of file HistoryProxySource.cpp.

◆ first()

QVariant HistoryProxySource::first ( ) const
overridevirtual

Reimplemented from ChartDataSource.

Definition at line 94 of file HistoryProxySource.cpp.

◆ interval()

int HistoryProxySource::interval ( ) const

Definition at line 164 of file HistoryProxySource.cpp.

◆ item() [1/2]

int HistoryProxySource::item ( ) const

Definition at line 129 of file HistoryProxySource.cpp.

◆ item() [2/2]

QVariant HistoryProxySource::item ( int index) const
overridevirtual

Implements ChartDataSource.

Definition at line 26 of file HistoryProxySource.cpp.

◆ itemCount()

int HistoryProxySource::itemCount ( ) const
overridevirtual

Implements ChartDataSource.

Definition at line 17 of file HistoryProxySource.cpp.

◆ maximum()

QVariant HistoryProxySource::maximum ( ) const
overridevirtual

Implements ChartDataSource.

Definition at line 76 of file HistoryProxySource.cpp.

◆ maximumHistory()

int HistoryProxySource::maximumHistory ( ) const

Definition at line 145 of file HistoryProxySource.cpp.

◆ minimum()

QVariant HistoryProxySource::minimum ( ) const
overridevirtual

Implements ChartDataSource.

Definition at line 56 of file HistoryProxySource.cpp.

◆ setFillMode()

void HistoryProxySource::setFillMode ( FillMode newFillMode)

Definition at line 198 of file HistoryProxySource.cpp.

◆ setInterval()

void HistoryProxySource::setInterval ( int newInterval)

Definition at line 169 of file HistoryProxySource.cpp.

◆ setItem()

void HistoryProxySource::setItem ( int newItem)

Definition at line 134 of file HistoryProxySource.cpp.

◆ setMaximumHistory()

void HistoryProxySource::setMaximumHistory ( int maximumHistory)

Definition at line 150 of file HistoryProxySource.cpp.

◆ setSource()

void HistoryProxySource::setSource ( ChartDataSource * newSource)

Definition at line 107 of file HistoryProxySource.cpp.

◆ source()

ChartDataSource * HistoryProxySource::source ( ) const

Definition at line 102 of file HistoryProxySource.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 18 2024 12:08:53 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.