summaryrefslogtreecommitdiff
path: root/src/ivicore/qiviserviceobject.cpp
blob: 523edf52bc1d077dae43a4101951f5e04bf370af (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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
/****************************************************************************
**
** Copyright (C) 2016 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 "qiviserviceobject.h"

#include <QUuid>

/*!
 * \class QIviServiceObject
 * \inmodule QtIviCore
 * \brief QIviServiceObject is the connection point to a Backend Service.
 *
 * QIviServiceObject provides you with a list of interfaces the Backend implements.
 *
 * By using interfaceInstance() a QObject implementing this interface will be returned.
 * The returned interface can contain signals that need to be connected to by the Feature
 * implementing this interface.
 *
 * \sa QIviAbstractFeature
 */


/*!
 * Constructor.
 *
 * \a parent is passed on to \l QObject.
 */
QIviServiceObject::QIviServiceObject(QObject *parent)
    : QObject(parent)
{

}

/*!
 * Destructor.
 */
QIviServiceObject::~QIviServiceObject()
{

}

/*!
 * \property QIviServiceObject::id
 * \brief A unique ID for the service object instance.
 *
 * Each service object has a unique ID. When subclassing, the id()
 * function can be overloaded to control the generation of the ID.
 */

/*!
 * The id() function can be overloaded to control the generation of
 * the unique ID used by this service object.
 *
 * By default, QUuid::createUuid() is used.
 */
QString QIviServiceObject::id() const
{
    static QUuid id = QUuid::createUuid();
    return id.toString();
}

/*!
 * \class QIviServiceInterface
 * \inmodule QtIviCore
 * \brief Interface class for services.
 *
 * The QIviServiceInterface class defines the interface of services registered with QIviServiceManager.
 *
 * Commonly, service objects inherit the concrete class QIviServiceObject instead of using QIviServiceInterface directly.
 *
 * \sa QIviServiceObject
 */

/*!
 * \fn QIviServiceInterface::~QIviServiceInterface()
 *
 * Destructs the QIviServiceInterface instance.
 */

/*!
 * \fn QStringList QIviServiceInterface::interfaces() const
 *
 * Returns a list of service interface names supported by the service object instance.
 */

/*!
 * \fn QObject* QIviServiceInterface::interfaceInstance(const QString& interface) const
 *
 * Returns an object implementing the service interface requested through \a interface.
 */