| /**************************************************************************** |
| ** |
| ** Copyright (C) 2017 The Qt Company Ltd. |
| ** Contact: http://www.qt.io/licensing/ |
| ** |
| ** This file is part of the QtSerialBus module of the Qt Toolkit. |
| ** |
| ** $QT_BEGIN_LICENSE:LGPL3$ |
| ** Commercial License Usage |
| ** Licensees holding valid commercial Qt licenses may use this file in |
| ** accordance with the commercial license agreement provided with the |
| ** Software or, alternatively, in accordance with the terms contained in |
| ** a written agreement between you and The Qt Company. For licensing terms |
| ** and conditions see http://www.qt.io/terms-conditions. For further |
| ** information use the contact form at http://www.qt.io/contact-us. |
| ** |
| ** GNU Lesser General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU Lesser |
| ** General Public License version 3 as published by the Free Software |
| ** Foundation and appearing in the file LICENSE.LGPLv3 included in the |
| ** packaging of this file. Please review the following information to |
| ** ensure the GNU Lesser General Public License version 3 requirements |
| ** will be met: https://www.gnu.org/licenses/lgpl.html. |
| ** |
| ** GNU General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU |
| ** General Public License version 2.0 or later as published by the Free |
| ** Software Foundation and appearing in the file LICENSE.GPL included in |
| ** the packaging of this file. Please review the following information to |
| ** ensure the GNU General Public License version 2.0 requirements will be |
| ** met: http://www.gnu.org/licenses/gpl-2.0.html. |
| ** |
| ** $QT_END_LICENSE$ |
| ** |
| ****************************************************************************/ |
| |
| #include "qcanbusfactory.h" |
| |
| QT_BEGIN_NAMESPACE |
| |
| /*! |
| \class QCanBusFactory |
| \inmodule QtSerialBus |
| \since 5.8 |
| \deprecated |
| |
| \brief The QCanBusFactory class is a factory class used as the |
| plugin interface for CAN bus plugins. |
| |
| All plugins must implement the functions provided by this factory class. |
| |
| This class is deprecated, you should use QCanBusFactoryV2 instead. |
| |
| \sa QCanBusFactoryV2 |
| */ |
| |
| /*! |
| \fn QCanBusDevice *QCanBusFactory::createDevice(const QString &interfaceName, |
| QString *errorMessage) const |
| |
| Creates a new QCanBusDevice. The caller must take ownership of the returned pointer. |
| |
| \a interfaceName is the CAN interface name and |
| \a errorMessage contains an error description in case of failure. |
| |
| If the factory cannot create a plugin, it returns \c nullptr. |
| */ |
| |
| /*! |
| \internal |
| |
| \fn QCanBusFactory::~QCanBusFactory() |
| */ |
| |
| /*! |
| \class QCanBusFactoryV2 |
| \inmodule QtSerialBus |
| \since 5.9 |
| |
| \brief The QCanBusFactoryV2 class is a factory class used as the |
| plugin interface for CAN bus plugins. |
| |
| All plugins must implement the functions provided by this factory class. |
| */ |
| |
| /*! |
| \fn QCanBusDevice *QCanBusFactoryV2::createDevice(const QString &interfaceName, |
| QString *errorMessage) const |
| |
| Creates a new QCanBusDevice. The caller must take ownership of the returned pointer. |
| |
| \a interfaceName is the CAN interface name and |
| \a errorMessage contains an error description in case of failure. |
| |
| If the factory cannot create a plugin, it returns \c nullptr. |
| */ |
| |
| /*! |
| \fn QList<QCanBusDeviceInfo> QCanBusFactoryV2::availableDevices(QString *errorMessage) const |
| |
| Returns the list of available devices and their capabilities for the QCanBusDevice. |
| |
| \a errorMessage contains an error description in case of failure. |
| */ |
| |
| /*! |
| * \internal |
| */ |
| QCanBusFactoryV2::~QCanBusFactoryV2() |
| { |
| } |
| |
| QT_END_NAMESPACE |