1 /****************************************************************************
2 **
3 ** Copyright (C) 2017 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the QtSerialBus module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL3$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPLv3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or later as published by the Free
28 ** Software Foundation and appearing in the file LICENSE.GPL included in
29 ** the packaging of this file. Please review the following information to
30 ** ensure the GNU General Public License version 2.0 requirements will be
31 ** met: http://www.gnu.org/licenses/gpl-2.0.html.
32 **
33 ** $QT_END_LICENSE$
34 **
35 ****************************************************************************/
36
37 #include "qcanbusfactory.h"
38
39 QT_BEGIN_NAMESPACE
40
41 /*!
42 \class QCanBusFactory
43 \inmodule QtSerialBus
44 \since 5.8
45 \deprecated
46
47 \brief The QCanBusFactory class is a factory class used as the
48 plugin interface for CAN bus plugins.
49
50 All plugins must implement the functions provided by this factory class.
51
52 This class is deprecated, you should use QCanBusFactoryV2 instead.
53
54 \sa QCanBusFactoryV2
55 */
56
57 /*!
58 \fn QCanBusDevice *QCanBusFactory::createDevice(const QString &interfaceName,
59 QString *errorMessage) const
60
61 Creates a new QCanBusDevice. The caller must take ownership of the returned pointer.
62
63 \a interfaceName is the CAN interface name and
64 \a errorMessage contains an error description in case of failure.
65
66 If the factory cannot create a plugin, it returns \c nullptr.
67 */
68
69 /*!
70 \internal
71
72 \fn QCanBusFactory::~QCanBusFactory()
73 */
74
75 /*!
76 \class QCanBusFactoryV2
77 \inmodule QtSerialBus
78 \since 5.9
79
80 \brief The QCanBusFactoryV2 class is a factory class used as the
81 plugin interface for CAN bus plugins.
82
83 All plugins must implement the functions provided by this factory class.
84 */
85
86 /*!
87 \fn QCanBusDevice *QCanBusFactoryV2::createDevice(const QString &interfaceName,
88 QString *errorMessage) const
89
90 Creates a new QCanBusDevice. The caller must take ownership of the returned pointer.
91
92 \a interfaceName is the CAN interface name and
93 \a errorMessage contains an error description in case of failure.
94
95 If the factory cannot create a plugin, it returns \c nullptr.
96 */
97
98 /*!
99 \fn QList<QCanBusDeviceInfo> QCanBusFactoryV2::availableDevices(QString *errorMessage) const
100
101 Returns the list of available devices and their capabilities for the QCanBusDevice.
102
103 \a errorMessage contains an error description in case of failure.
104 */
105
106 /*!
107 * \internal
108 */
~QCanBusFactoryV2()109 QCanBusFactoryV2::~QCanBusFactoryV2()
110 {
111 }
112
113 QT_END_NAMESPACE
114