BPS C++ API  2.24.4
BpsScales Class Referenceabstract

Scales interface. More...

#include <bpsscales.h>

+ Inheritance diagram for BpsScales:

Public Types

enum  { StatusStable = 0 , StatusDynamic = 1 , StatusOverload = 2 , StatusUnderload = 3 , StatusError = 4 }
 Read status.
 

Signals

void clearTareError (const QString &aMessage)
 Signal emitted as failure result of a requestClearTare() call. More...
 
void clearTareOk ()
 Signal emitted as success result of a requestClearTare() call.
 
void error (const QString &aMessage)
 Combined failure signal from readWeightError(), readTareError(), takeTareError() and clearTareError(). More...
 
void ok ()
 Combined success signal from readWeightOk(), readTareOk(), takeTareOk() and clearTareOk().
 
void readTareError (const QString &aMessage)
 Signal emitted as failure result of a requestReadTare() call. More...
 
void readTareOk (const BpsDecimal &aTare)
 Signal emitted as success result of a requestReadWeight() call. More...
 
void readWeightError (const QString &aMessage)
 Signal emitted as failure result of a requestReadWeight() call. More...
 
void readWeightOk (int aStatus, const BpsDecimal &aWeight, bool aTared)
 Signal emitted as success result of a requestReadWeight() call. More...
 
void takeTareError (const QString &aMessage)
 Signal emitted as failure result of a requestTakeTare() call. More...
 
void takeTareOk ()
 Signal emitted as success result of a requestTakeTare() call.
 

Public Member Functions

 BpsScales (QObject *aParent=0)
 
virtual bool canTare () const
 Information if requestReadTare(), requestTakeTare() and requestClearTare() are supported. More...
 
QMap< QString, QStringconfig () const
 
virtual void requestClearTare ()
 Request clearing of the tare, going back to gross weight.
 
virtual void requestReadTare ()
 Request reading of the current tare status and weight.
 
virtual void requestReadWeight ()=0
 Request the reading of a scales status and weight.
 
virtual void requestTakeTare ()
 Request taring of the current stable weight, going to net weight.
 
void setConfig (const QMap< QString, QString > &aConfig)
 Set the scales configuration. More...
 
virtual ~BpsScales ()
 Virtual default destructor.
 
- Public Member Functions inherited from QObject
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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
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 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 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_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
 
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)
 
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 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)
 
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)
 
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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Scales interface.

Scales 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

◆ BpsScales()

BpsScales::BpsScales ( QObject aParent = 0)
Parameters
aParentThe parent object.

Member Function Documentation

◆ canTare()

virtual bool BpsScales::canTare ( ) const
virtual

Information if requestReadTare(), requestTakeTare() and requestClearTare() are supported.

The default implementation returns false. Overload this method to return true in case.

Returns
True if tare operations are supported.

◆ clearTareError

void BpsScales::clearTareError ( const QString aMessage)
signal

Signal emitted as failure result of a requestClearTare() call.

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

◆ config()

QMap<QString,QString> BpsScales::config ( ) const
Returns
The scales configuration with lowercase keys, and trimmed keys and values.
See also
Bps::lowerKeyStringMap().

◆ error

void BpsScales::error ( const QString aMessage)
signal

Combined failure signal from readWeightError(), readTareError(), takeTareError() and clearTareError().

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

◆ readTareError

void BpsScales::readTareError ( const QString aMessage)
signal

Signal emitted as failure result of a requestReadTare() call.

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

◆ readTareOk

void BpsScales::readTareOk ( const BpsDecimal aTare)
signal

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

Parameters
aTareThe current tare weight.

◆ readWeightError

void BpsScales::readWeightError ( const QString aMessage)
signal

Signal emitted as failure result of a requestReadWeight() call.

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

◆ readWeightOk

void BpsScales::readWeightOk ( int  aStatus,
const BpsDecimal aWeight,
bool  aTared 
)
signal

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

Parameters
aStatusThe scales status.
aWeightThe current weight in case of StatusStable or StatusDynamic. May be gross or net, depending on tare status.
aTaredTrue when the scales is known to be tared and the weight is net; false when tare status unknown or scales is not tared and weight is gross. Only valid when StatusStable or StatusDynamic.

◆ setConfig()

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

Set the scales configuration.

This should be done before making requests.

Parameters
aConfigThe scales configuration.

◆ takeTareError

void BpsScales::takeTareError ( const QString aMessage)
signal

Signal emitted as failure result of a requestTakeTare() call.

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

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