diff options
author | Alex Blasche <alexander.blasche@theqtcompany.com> | 2015-07-20 11:13:22 +0200 |
---|---|---|
committer | Alex Blasche <alexander.blasche@theqtcompany.com> | 2015-07-21 10:08:58 +0000 |
commit | ebb3c41ff7430fd0e4b47c1aefab2f7d853b45a5 (patch) | |
tree | b8acb92d16289783a469e35926ab72fc81913015 /src/serialbus/qcanbusfactory.cpp | |
parent | be9b18ab517f6ddb495a0dcd985794ed00276921 (diff) |
Add new QCanBusFactory plugin interface
This is a first step towards a single plugin interface for canbus
plugins. The existing interfaces QSerialBusBackendFactory and
QSerialBusPluginInterface have the wrong names and really, there is
no need to have two interfaces anymore.
In fact QSerialBusPluginInterface is not required at all.
Change-Id: I6100e0bec302539a986e975a5c4066c09e0bbcf0
Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
Reviewed-by: Alex Blasche <alexander.blasche@theqtcompany.com>
Diffstat (limited to 'src/serialbus/qcanbusfactory.cpp')
-rw-r--r-- | src/serialbus/qcanbusfactory.cpp | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/src/serialbus/qcanbusfactory.cpp b/src/serialbus/qcanbusfactory.cpp new file mode 100644 index 0000000..649ab00 --- /dev/null +++ b/src/serialbus/qcanbusfactory.cpp @@ -0,0 +1,75 @@ +/**************************************************************************** +** +** Copyright (C) 2015 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.6 + + \brief The QCanBusFactory class is a factory class used as the + plugin interface for can bus plugins. + + This functions must be implemented by all plugins. + */ + +/*! + \fn QCanBusDevice *QCanBusFactory::createDevice(const QString &identifier, const QString &interfaceName) const + + Returns a new QCanBusDevice associated with \a identifier. + \a interfaceName is the network/CAN interface name. The caller must take + ownership of the returned pointer. + + If the factory cannot create a backend, it returns 0. +*/ + +/*! + \fn QCanBusFactory::availableBackends() const + + Lists the available backends inside the plugin. +*/ + +/*! + \internal + */ +QCanBusFactory::~QCanBusFactory() +{ +} + +QT_END_NAMESPACE |