QCanBusFactory Class

The QCanBusFactory class is a factory class used as the plugin interface for CAN bus plugins. More...

Header: #include <QCanBusFactory>
CMake: find_package(Qt6 COMPONENTS SerialBus REQUIRED)
target_link_libraries(mytarget PRIVATE Qt6::SerialBus)
qmake: QT += serialbus
Since: Qt 5.9

Public Functions

virtual QList<QCanBusDeviceInfo> availableDevices(QString *errorMessage) const = 0
virtual QCanBusDevice *createDevice(const QString &interfaceName, QString *errorMessage) const = 0

Detailed Description

All plugins must implement the functions provided by this factory class.

Member Function Documentation

[pure virtual] QList<QCanBusDeviceInfo> QCanBusFactory::availableDevices(QString *errorMessage) const

Returns the list of available devices and their capabilities for the QCanBusDevice.

errorMessage contains an error description in case of failure.

[pure virtual] QCanBusDevice *QCanBusFactory::createDevice(const QString &interfaceName, QString *errorMessage) const

Creates a new QCanBusDevice. The caller must take ownership of the returned pointer.

interfaceName is the CAN interface name and errorMessage contains an error description in case of failure.

If the factory cannot create a plugin, it returns nullptr.

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.