blob: 4f3ef6323d8c01b34b98a0fcf2f5f4850584366b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
/****************************************************************************
**
** Copyright (C) 2019 Luxoft Sweden AB
** Copyright (C) 2018 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtIvi module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL-QTAS$
** Commercial License Usage
** Licensees holding valid commercial Qt Automotive Suite 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 https://www.qt.io/terms-conditions.
** For further information use the contact form at https://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.LGPL3 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-3.0.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 (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
** SPDX-License-Identifier: LGPL-3.0
**
****************************************************************************/
#include "qivifeatureinterface.h"
QT_BEGIN_NAMESPACE
/*!
\class QIviFeatureInterface
\inmodule QtIviCore
\ingroup backends
\brief QIviFeatureInterface defines the base class for all backends.
To implement a backend for a specific feature you need to derive from this class.
There's a one-to-one mapping between a spezialized feature API and its corresponding feature interface
class.
The feature interface class specifies which functions and signals need to be implemented by a backend
to work with a specific feature.
This base class contains the generic error handling, which is common between all interfaces.
See the full example backend implementation from \c {src/plugins/ivivehiclefunctions/climate_simulator}.
\sa QIviAbstractFeature, QIviServiceInterface
*/
QIviFeatureInterface::QIviFeatureInterface(QObject *parent)
: QObject(parent)
{
}
QIviFeatureInterface::QIviFeatureInterface(QObjectPrivate &dd, QObject *parent)
: QObject(dd, parent)
{
}
/*!
\fn void QIviFeatureInterface::initialize()
Initializes the backend. This function is called after a feature connected to the backend.
It is expected that this function will inform about the current state of the backend by
emitting signals with the current status.
The last signal which needs to be sent is the initializationDone() signal.
\sa initializationDone()
*/
/*!
\fn void QIviFeatureInterface::errorChanged(QIviAbstractFeature::Error error, const QString &message = QString())
The signal is emitted when \a error occurs in the backend.
Error \a message is optional.
*/
/*!
\fn void QIviFeatureInterface::initializationDone()
The signal is emitted once the current backend state has been sent to the feature after
a call to initialize()
\sa initialize
*/
QT_END_NAMESPACE
|
