QtPokit
Native Qt library for Pokit devices
Loading...
Searching...
No Matches
AbstractPokitService Class Referenceabstract

The AbstractPokitService class provides a common base for Pokit services classes. More...

Inheritance diagram for AbstractPokitService:
[legend]
Collaboration diagram for AbstractPokitService:
[legend]

Signals

void serviceDetailsDiscovered ()
 This signal is emitted when the Pokit service details have been discovered. More...
 
void serviceErrorOccurred (QLowEnergyService::ServiceError newError)
 This signal is emitted whenever an error occurs on the underlying QLowEnergyService.
 

Public Member Functions

virtual ~AbstractPokitService ()
 Destroys this AbstractPokitService object.
 
virtual bool readCharacteristics ()=0
 Read all characteristics. More...
 
bool autoDiscover () const
 Returns true if autodiscovery of services and service details is enabled, false otherwise. More...
 
void setAutoDiscover (const bool discover=true)
 If discover is true, autodiscovery will be attempted. More...
 
QLowEnergyServiceservice ()
 Returns a non-const pointer to the internal service object, if any.
 
const QLowEnergyServiceservice () const
 Returns a const pointer to the internal service object, if any.
 
- Public Member Functions inherited from QObject
virtual const QMetaObjectmetaObject () const const
 
virtual void * qt_metacast (const char *)
 
virtual int qt_metacall (QMetaObject::Call, int, void **)
 
 QObject (QObject *parent)
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
QString objectName () const const
 
void setObjectName (const QString &name)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
bool signalsBlocked () const const
 
bool blockSignals (bool block)
 
QThreadthread () const const
 
void moveToThread (QThread *targetThread)
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
void killTimer (int id)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (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
 
const QObjectList & children () const const
 
void setParent (QObject *parent)
 
void installEventFilter (QObject *filterObj)
 
void removeEventFilter (QObject *obj)
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectTree ()
 
void dumpObjectInfo ()
 
void dumpObjectTree () const const
 
void dumpObjectInfo () const const
 
bool setProperty (const char *name, const QVariant &value)
 
QVariant property (const char *name) const const
 
QList< QByteArraydynamicPropertyNames () const const
 
void destroyed (QObject *obj)
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
bool inherits (const char *className) const const
 
void deleteLater ()
 

Friends

class TestAbstractPokitService
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
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 QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
- Protected Member Functions inherited from QObject
QObjectsender () const const
 
int senderSignalIndex () const const
 
int receivers (const char *signal) const const
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
virtual void timerEvent (QTimerEvent *event)
 
virtual void childEvent (QChildEvent *event)
 
virtual void customEvent (QEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

The AbstractPokitService class provides a common base for Pokit services classes.

Member Function Documentation

◆ autoDiscover()

bool AbstractPokitService::autoDiscover ( ) const

Returns true if autodiscovery of services and service details is enabled, false otherwise.

See also
setAutoDiscover for more information on what autodiscovery provides.

◆ readCharacteristics()

bool AbstractPokitService::readCharacteristics ( )
pure virtual

Read all characteristics.

This convenience function will queue refresh requests of all characteristics supported by this service.

Relevant *Service::*Read signals will be emitted by derived class objects as each characteristic is successfully read.

Implemented in CalibrationService, DataLoggerService, DeviceInfoService, DsoService, GenericAccessService, MultimeterService, and StatusService.

◆ serviceDetailsDiscovered

void AbstractPokitService::serviceDetailsDiscovered ( )
signal

This signal is emitted when the Pokit service details have been discovered.

Once this signal has been emitted, cached characteristics values should be immediately available via derived classes' accessor functions, and refreshes can be queued via readCharacteristics() and any related read functions provided by derived classes.

◆ setAutoDiscover()

void AbstractPokitService::setAutoDiscover ( const bool  discover = true)

If discover is true, autodiscovery will be attempted.

Specifically, this may resulting in automatic invocation of:

See also
autoDiscover

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