1/****************************************************************************
2**
3** Copyright (C) 2012 Denis Shienkov <denis.shienkov@gmail.com>
4** Copyright (C) 2012 Laszlo Papp <lpapp@kde.org>
5** Contact: https://www.qt.io/licensing/
6**
7** This file is part of the QtSerialPort module of the Qt Toolkit.
8**
9** $QT_BEGIN_LICENSE:LGPL$
10** Commercial License Usage
11** Licensees holding valid commercial Qt licenses may use this file in
12** accordance with the commercial license agreement provided with the
13** Software or, alternatively, in accordance with the terms contained in
14** a written agreement between you and The Qt Company. For licensing terms
15** and conditions see https://www.qt.io/terms-conditions. For further
16** information use the contact form at https://www.qt.io/contact-us.
17**
18** GNU Lesser General Public License Usage
19** Alternatively, this file may be used under the terms of the GNU Lesser
20** General Public License version 3 as published by the Free Software
21** Foundation and appearing in the file LICENSE.LGPL3 included in the
22** packaging of this file. Please review the following information to
23** ensure the GNU Lesser General Public License version 3 requirements
24** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
25**
26** GNU General Public License Usage
27** Alternatively, this file may be used under the terms of the GNU
28** General Public License version 2.0 or (at your option) the GNU General
29** Public license version 3 or any later version approved by the KDE Free
30** Qt Foundation. The licenses are as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
32** included in the packaging of this file. Please review the following
33** information to ensure the GNU General Public License requirements will
34** be met: https://www.gnu.org/licenses/gpl-2.0.html and
35** https://www.gnu.org/licenses/gpl-3.0.html.
36**
37** $QT_END_LICENSE$
38**
39****************************************************************************/
40
41#ifndef QSERIALPORTINFO_H
42#define QSERIALPORTINFO_H
43
44#include <QtCore/qlist.h>
45#include <QtCore/qscopedpointer.h>
46
47#include <QtSerialPort/qserialportglobal.h>
48
49QT_BEGIN_NAMESPACE
50
51class QSerialPort;
52class QSerialPortInfoPrivate;
53class QSerialPortInfoPrivateDeleter;
54
55class Q_SERIALPORT_EXPORT QSerialPortInfo
56{
57 Q_DECLARE_PRIVATE(QSerialPortInfo)
58public:
59 QSerialPortInfo();
60 explicit QSerialPortInfo(const QSerialPort &port);
61 explicit QSerialPortInfo(const QString &name);
62 QSerialPortInfo(const QSerialPortInfo &other);
63 ~QSerialPortInfo();
64
65 QSerialPortInfo& operator=(const QSerialPortInfo &other);
66 void swap(QSerialPortInfo &other);
67
68 QString portName() const;
69 QString systemLocation() const;
70 QString description() const;
71 QString manufacturer() const;
72 QString serialNumber() const;
73
74 quint16 vendorIdentifier() const;
75 quint16 productIdentifier() const;
76
77 bool hasVendorIdentifier() const;
78 bool hasProductIdentifier() const;
79
80 bool isNull() const;
81#if QT_DEPRECATED_SINCE(5, 6)
82 bool isBusy() const;
83#endif
84#if QT_DEPRECATED_SINCE(5, 2)
85 QT_DEPRECATED bool isValid() const;
86#endif
87
88 static QList<qint32> standardBaudRates();
89 static QList<QSerialPortInfo> availablePorts();
90
91private:
92 QSerialPortInfo(const QSerialPortInfoPrivate &dd);
93 friend QList<QSerialPortInfo> availablePortsByUdev(bool &ok);
94 friend QList<QSerialPortInfo> availablePortsBySysfs(bool &ok);
95 friend QList<QSerialPortInfo> availablePortsByFiltersOfDevices(bool &ok);
96 QScopedPointer<QSerialPortInfoPrivate, QSerialPortInfoPrivateDeleter> d_ptr;
97};
98
99inline bool QSerialPortInfo::isNull() const
100{ return !d_ptr; }
101
102QT_END_NAMESPACE
103
104#endif // QSERIALPORTINFO_H
105