Gauge interface. More...

#include <bpsgauge.h>

Inheritance diagram for BpsGauge:

Public Types
enum	{ StatusStable = 0 , StatusDynamic = 1 }
	Read status.

enum	Unit { UnitCelsius = 0 , UnitPH = 1 }
	Value unit.

Signals
void	error (const QString &aMessage)
	Combined failure signal from readValueTimeout() and readValueError(). More...

void	readValueError (const QString &aMessage)
	Signal emitted as failure result of a requestReadValue() for all other reasons except timeout. More...

void	readValueOk (int aStatus, const BpsDecimal &aValue)
	Signal emitted as success result of a requestReadValue() call. More...

void	readValueTimeout (const QString &aMessage)
	Signal emitted as failure result of a requestReadValue() call when nothing was received withing the specified timeout. More...

Public Member Functions
	BpsGauge (QObject *aParent=0)

QMap< QString, QString >	config () const

virtual void	requestReadValue (int aTimeout=0)=0
	Request the reading of status and value. More...

virtual int	resolution () const =0
	Resolution of the values returned. More...

void	setConfig (const QMap< QString, QString > &aConfig)
	Set the configuration. More...

virtual Unit	unit () const =0
	Unit of the values returned. More...

virtual	~BpsGauge ()
	Virtual default destructor.

Public Member Functions inherited from QObject
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 ()

void	dumpObjectInfo () const const

void	dumpObjectTree ()

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 QRegExp &regExp, 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

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

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_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	Q_DISABLE_MOVE (Class)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	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	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

	QObject (QObject *parent)

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	setParent (QObject *parent)

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

bool	signalsBlocked () const const

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

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

QThread *	thread () 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)

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

Public Attributes inherited from QObject
typedef	QObjectList

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)

Properties inherited from QObject
	objectName

Detailed Description

Gauge interface.

Gauge interfaces operate similar as a thread, where commands are given by request calls, and results are returned as signals. Background operations are however implemented with QTimer, so the requesting thread must have an event queue. Overlapped requests are not supported, subsequent requests should be made only after the previous has been answered by a signal.

Constructor & Destructor Documentation

◆ BpsGauge()

BpsGauge::BpsGauge ( QObject * aParent = 0 )

Parameters

aParent The parent object.

Member Function Documentation

◆ config()

QMap<QString,QString> BpsGauge::config ( ) const

Returns: The configuration with lowercase keys, and trimmed keys and values.

See also: Bps::lowerKeyStringMap().

◆ error

void BpsGauge::error ( const QString & aMessage )

signal

Combined failure signal from readValueTimeout() and readValueError().

Parameters

aMessage Information about the failure reason (for example "Timeout", "Device not open" etc.)

◆ readValueError

void BpsGauge::readValueError ( const QString & aMessage )

signal

Signal emitted as failure result of a requestReadValue() for all other reasons except timeout.

Parameters

aMessage Information about the failure reason (for example "Device can not be opened", "Checksum error" etc.)

◆ readValueOk

void BpsGauge::readValueOk	(	int	aStatus,
		const BpsDecimal &	aValue
	)

signal

Signal emitted as success result of a requestReadValue() call.

Parameters

aStatus	The value status.
aValue	The current value.

◆ readValueTimeout

void BpsGauge::readValueTimeout ( const QString & aMessage )

signal

Signal emitted as failure result of a requestReadValue() call when nothing was received withing the specified timeout.

Parameters

aMessage Information about the failure reason ("Timeout")

◆ requestReadValue()

virtual void BpsGauge::requestReadValue ( int aTimeout = 0 )

pure virtual

Request the reading of status and value.

Parameters

aTimeout Time out in seconds. Special values: 0 = no wait, -1 = wait endless

◆ resolution()

virtual int BpsGauge::resolution ( ) const

pure virtual

Resolution of the values returned.

Positive values denote fractional digits. For example 3 stands for steps of 0.001, 0 are steps of 1, and -2 are steps of 100.

Returns: Resolution in digits.

◆ setConfig()

void BpsGauge::setConfig ( const QMap< QString, QString > & aConfig )

Set the configuration.

This should be done before making requests.

Parameters

aConfig The gauge configuration, usually the values in Central System Settings/Terminals/TERMINAL/Devices/Gauges/{device no}.

◆ unit()

virtual Unit BpsGauge::unit ( ) const

pure virtual

Unit of the values returned.

Returns: Value type.

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

bpsgauge.h

Public Types

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BpsGauge()

Member Function Documentation

◆ config()

◆ error

◆ readValueError

◆ readValueOk

◆ readValueTimeout

◆ requestReadValue()

◆ resolution()

◆ setConfig()

◆ unit()