Dokit
Internal development documentation
Loading...
Searching...
No Matches
PokitDiscoveryAgent Class Reference

The PokitDiscoveryAgent class discovers nearby Pokit devices. More...

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

Public Slots

void start (QBluetoothDeviceDiscoveryAgent::DiscoveryMethods methods)
 Starts Pokit device discovery.
void start ()
 Starts Pokit device discovery.

Signals

void pokitDeviceDiscovered (const QBluetoothDeviceInfo &info)
 This signal is emitted when the Pokit device described by info is discovered.
void pokitDeviceUpdated (const QBluetoothDeviceInfo &info, QBluetoothDeviceInfo::Fields updatedFields)
 This signal is emitted when the Pokit device described by info is updated.

Public Member Functions

 PokitDiscoveryAgent (const QBluetoothAddress &deviceAdapter, QObject *parent=nullptr)
 Constructs a new Pokit device discovery agent with parent, using deviceAdapter for the search device.
 PokitDiscoveryAgent (QObject *parent=nullptr)
 Constructs a new Pokit device discovery agent with parent.
virtual ~PokitDiscoveryAgent ()
 Destroys this PokitDiscoveryAgent object.
Public Member Functions inherited from QBluetoothDeviceDiscoveryAgent
 QBluetoothDeviceDiscoveryAgent (QObject *parent)
 QBluetoothDeviceDiscoveryAgent (const QBluetoothAddress &deviceAdapter, QObject *parent)
QBluetoothDeviceDiscoveryAgent::InquiryType inquiryType () const const
void setInquiryType (QBluetoothDeviceDiscoveryAgent::InquiryType type)
bool isActive () const const
QBluetoothDeviceDiscoveryAgent::Error error () const const
QString errorString () const const
QList< QBluetoothDeviceInfodiscoveredDevices () const const
void setLowEnergyDiscoveryTimeout (int timeout)
int lowEnergyDiscoveryTimeout () const const
void start ()
void start (QBluetoothDeviceDiscoveryAgent::DiscoveryMethods methods)
void stop ()
void deviceDiscovered (const QBluetoothDeviceInfo &info)
void deviceUpdated (const QBluetoothDeviceInfo &info, QBluetoothDeviceInfo::Fields updatedFields)
void finished ()
void error (QBluetoothDeviceDiscoveryAgent::Error error)
void canceled ()
Public Member Functions inherited from QObject
virtual const QMetaObjectmetaObject () const const
 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 QObjectListchildren () 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 ()
 Q_DISABLE_COPY (Class)
 Q_DISABLE_MOVE (Class)
 Q_DISABLE_COPY_MOVE (Class)
qobject_cast (QObject *object)
qobject_cast (const QObject *object)
qFindChild (const QObject *obj, const QString &name)
QList< T > qFindChildren (const QObject *obj, const QString &name)
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 Q_CLASSINFO (Name, Value)
 Q_INTERFACES (...)
 Q_PROPERTY (...)
 Q_ENUMS (...)
 Q_FLAGS (...)
 Q_ENUM (...)
 Q_FLAG (...)
 Q_ENUM_NS (...)
 Q_FLAG_NS (...)
 Q_OBJECT Q_OBJECT
 Q_GADGET Q_GADGET
 Q_NAMESPACE Q_NAMESPACE
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 Q_SIGNALS Q_SIGNALS
 Q_SIGNAL Q_SIGNAL
 Q_SLOTS Q_SLOTS
 Q_SLOT Q_SLOT
 Q_EMIT Q_EMIT
 Q_INVOKABLE Q_INVOKABLE
 Q_REVISION Q_REVISION
 Q_SET_OBJECT_NAME (Object)
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

Protected Member Functions

 PokitDiscoveryAgent (PokitDiscoveryAgentPrivate *const d, const QBluetoothAddress &deviceAdapter, QObject *const parent)
 Constructs a new Pokit device discovery agent with parent, using deviceAdapter for the search device, and private implementation d.
 PokitDiscoveryAgent (PokitDiscoveryAgentPrivate *const d, QObject *const parent)
 Constructs a new Pokit device discovery agent with parent, and private implementation d.
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)

Protected Attributes

PokitDiscoveryAgentPrivated_ptr
 Internal d-pointer.

Additional Inherited Members

Public Types inherited from QBluetoothDeviceDiscoveryAgent
enum  Error
enum  InquiryType
enum  DiscoveryMethod
Static Public Member Functions inherited from QBluetoothDeviceDiscoveryAgent
QBluetoothDeviceDiscoveryAgent::DiscoveryMethods supportedDiscoveryMethods ()
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)
Public Attributes inherited from QBluetoothDeviceDiscoveryAgent
typedef DiscoveryMethods
 NoError
 InputOutputError
 PoweredOffError
 InvalidBluetoothAdapterError
 UnsupportedPlatformError
 UnsupportedDiscoveryMethod
 UnknownError
 GeneralUnlimitedInquiry
 LimitedInquiry
 NoMethod
 ClassicMethod
 LowEnergyMethod
Public Attributes inherited from QObject
typedef QObjectList
Properties inherited from QBluetoothDeviceDiscoveryAgent
 inquiryType
Properties inherited from QObject
 objectName

Detailed Description

The PokitDiscoveryAgent class discovers nearby Pokit devices.

After constructing a PokitDiscoveryAgent object, and subscribing to the relevant signals, invoke start() to begin discovery.

Definition at line 20 of file pokitdiscoveryagent.h.

Constructor & Destructor Documentation

◆ PokitDiscoveryAgent() [1/4]

PokitDiscoveryAgent::PokitDiscoveryAgent ( const QBluetoothAddress & deviceAdapter,
QObject * parent = nullptr )
explicit

Constructs a new Pokit device discovery agent with parent, using deviceAdapter for the search device.

Definition at line 32 of file pokitdiscoveryagent.cpp.

34 : QBluetoothDeviceDiscoveryAgent(deviceAdapter, parent),
35 d_ptr(new PokitDiscoveryAgentPrivate(this))
36{
37
38}
PokitDiscoveryAgentPrivate * d_ptr
Internal d-pointer.
QBluetoothDeviceDiscoveryAgent(QObject *parent)
QObject * parent() const const

References d_ptr, QObject::parent(), QBluetoothDeviceDiscoveryAgent::QBluetoothDeviceDiscoveryAgent(), and QObject::QObject().

Referenced by start(), and start().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ PokitDiscoveryAgent() [2/4]

PokitDiscoveryAgent::PokitDiscoveryAgent ( QObject * parent = nullptr)

Constructs a new Pokit device discovery agent with parent.

Definition at line 43 of file pokitdiscoveryagent.cpp.

45 d_ptr(new PokitDiscoveryAgentPrivate(this))
46{
47
48}

References d_ptr, QObject::parent(), QBluetoothDeviceDiscoveryAgent::QBluetoothDeviceDiscoveryAgent(), and QObject::QObject().

Here is the call graph for this function:

◆ ~PokitDiscoveryAgent()

PokitDiscoveryAgent::~PokitDiscoveryAgent ( )
virtual

Destroys this PokitDiscoveryAgent object.

Definition at line 77 of file pokitdiscoveryagent.cpp.

78{
79 delete d_ptr;
80}

References d_ptr.

◆ PokitDiscoveryAgent() [3/4]

PokitDiscoveryAgent::PokitDiscoveryAgent ( PokitDiscoveryAgentPrivate *const d,
const QBluetoothAddress & deviceAdapter,
QObject *const parent )
protected

Constructs a new Pokit device discovery agent with parent, using deviceAdapter for the search device, and private implementation d.

Definition at line 55 of file pokitdiscoveryagent.cpp.

58 : QBluetoothDeviceDiscoveryAgent(deviceAdapter, parent), d_ptr(d)
59{
60
61}

References d_ptr, QObject::parent(), QBluetoothDeviceDiscoveryAgent::QBluetoothDeviceDiscoveryAgent(), and QObject::QObject().

Here is the call graph for this function:

◆ PokitDiscoveryAgent() [4/4]

PokitDiscoveryAgent::PokitDiscoveryAgent ( PokitDiscoveryAgentPrivate *const d,
QObject *const parent )
protected

Constructs a new Pokit device discovery agent with parent, and private implementation d.

Definition at line 66 of file pokitdiscoveryagent.cpp.

References d_ptr, QObject::parent(), QBluetoothDeviceDiscoveryAgent::QBluetoothDeviceDiscoveryAgent(), and QObject::QObject().

Here is the call graph for this function:

Member Function Documentation

◆ pokitDeviceUpdated

void PokitDiscoveryAgent::pokitDeviceUpdated ( const QBluetoothDeviceInfo & info,
QBluetoothDeviceInfo::Fields updatedFields )
signal

This signal is emitted when the Pokit device described by info is updated.

The updatedFields flags tell which information has been updated.

References QBluetoothDeviceInfo::Fields.

Referenced by ScanCommand::ScanCommand().

Here is the caller graph for this function:

◆ start [1/2]

void PokitDiscoveryAgent::start ( )
slot

Starts Pokit device discovery.

Definition at line 99 of file pokitdiscoveryagent.cpp.

100{
102 qCDebug(d->lc).noquote() << tr("Scanning for Bluetooth Low Energy devices.");
104}
PokitDiscoveryAgent(const QBluetoothAddress &deviceAdapter, QObject *parent=nullptr)
Constructs a new Pokit device discovery agent with parent, using deviceAdapter for the search device.
QString tr(const char *sourceText, const char *disambiguation, int n)

References QBluetoothDeviceDiscoveryAgent::LowEnergyMethod, PokitDiscoveryAgent(), QBluetoothDeviceDiscoveryAgent::start(), and QObject::tr().

Here is the call graph for this function:

◆ start [2/2]

void PokitDiscoveryAgent::start ( QBluetoothDeviceDiscoveryAgent::DiscoveryMethods methods)
slot

Starts Pokit device discovery.

This override simply enforces that method must be LowEnergyMethod, as all Pokit devices used Bluetooth Low Energy (BLE).

Definition at line 88 of file pokitdiscoveryagent.cpp.

89{
92 qCDebug(d->lc).noquote() << tr("Scanning for Bluetooth Low Energy devices.");
94}

References QBluetoothDeviceDiscoveryAgent::DiscoveryMethods, QBluetoothDeviceDiscoveryAgent::LowEnergyMethod, PokitDiscoveryAgent(), QBluetoothDeviceDiscoveryAgent::start(), and QObject::tr().

Here is the call graph for this function:

Member Data Documentation

◆ d_ptr

PokitDiscoveryAgentPrivate* PokitDiscoveryAgent::d_ptr
protected

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