| 1 | // Copyright (C) 2017 The Qt Company Ltd. |
|---|
| 2 | // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only |
|---|
| 3 | |
|---|
| 4 | #include "qcanbusfactory.h" |
|---|
| 5 | |
|---|
| 6 | QT_BEGIN_NAMESPACE |
|---|
| 7 | |
|---|
| 8 | /*! |
|---|
| 9 | \class QCanBusFactory |
|---|
| 10 | \inmodule QtSerialBus |
|---|
| 11 | \since 5.9 |
|---|
| 12 | |
|---|
| 13 | \brief The QCanBusFactory class is a factory class used as the |
|---|
| 14 | plugin interface for CAN bus plugins. |
|---|
| 15 | |
|---|
| 16 | All plugins must implement the functions provided by this factory class. |
|---|
| 17 | */ |
|---|
| 18 | |
|---|
| 19 | /*! |
|---|
| 20 | \fn QCanBusDevice *QCanBusFactory::createDevice(const QString &interfaceName, |
|---|
| 21 | QString *errorMessage) const |
|---|
| 22 | |
|---|
| 23 | Creates a new QCanBusDevice. The caller must take ownership of the returned pointer. |
|---|
| 24 | |
|---|
| 25 | \a interfaceName is the CAN interface name and |
|---|
| 26 | \a errorMessage contains an error description in case of failure. |
|---|
| 27 | |
|---|
| 28 | If the factory cannot create a plugin, it returns \c nullptr. |
|---|
| 29 | */ |
|---|
| 30 | |
|---|
| 31 | /*! |
|---|
| 32 | \fn QList<QCanBusDeviceInfo> QCanBusFactory::availableDevices(QString *errorMessage) const |
|---|
| 33 | |
|---|
| 34 | Returns the list of available devices and their capabilities for the QCanBusDevice. |
|---|
| 35 | |
|---|
| 36 | \a errorMessage contains an error description in case of failure. |
|---|
| 37 | */ |
|---|
| 38 | |
|---|
| 39 | /*! |
|---|
| 40 | * \internal |
|---|
| 41 | */ |
|---|
| 42 | QCanBusFactory::~QCanBusFactory() |
|---|
| 43 | { |
|---|
| 44 | } |
|---|
| 45 | |
|---|
| 46 | QT_END_NAMESPACE |
|---|
| 47 | |
|---|
