Warning: That file was not part of the compilation database. It may have many parsing errors.

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#ifndef QMODBUSDEVICE_H
37#define QMODBUSDEVICE_H
38
39#include <QtCore/qobject.h>
40#include <QtCore/qiodevice.h>
41#include <QtSerialBus/qtserialbusglobal.h>
42
43QT_BEGIN_NAMESPACE
44
45class QModbusDevicePrivate;
46
47class Q_SERIALBUS_EXPORT QModbusDevice : public QObject
48{
49 Q_OBJECT
50 Q_DECLARE_PRIVATE(QModbusDevice)
51
52public:
53 enum Error {
54 NoError,
55 ReadError,
56 WriteError,
57 ConnectionError,
58 ConfigurationError,
59 TimeoutError,
60 ProtocolError,
61 ReplyAbortedError,
62 UnknownError
63 };
64 Q_ENUM(Error)
65
66 enum State {
67 UnconnectedState,
68 ConnectingState,
69 ConnectedState,
70 ClosingState
71 };
72 Q_ENUM(State)
73
74 enum ConnectionParameter {
75 SerialPortNameParameter,
76 SerialParityParameter,
77 SerialBaudRateParameter,
78 SerialDataBitsParameter,
79 SerialStopBitsParameter,
80
81 NetworkPortParameter,
82 NetworkAddressParameter,
83
84 // Reserved
85 UserParameter = 0x100 // ### Qt6: remove
86 };
87 Q_ENUM(ConnectionParameter)
88
89 explicit QModbusDevice(QObject *parent = nullptr);
90 ~QModbusDevice();
91
92 QVariant connectionParameter(int parameter) const;
93 void setConnectionParameter(int parameter, const QVariant &value);
94
95 bool connectDevice();
96 void disconnectDevice();
97
98 State state() const;
99
100 Error error() const;
101 QString errorString() const;
102
103 QIODevice *device() const;
104
105Q_SIGNALS:
106 void errorOccurred(QModbusDevice::Error error);
107 void stateChanged(QModbusDevice::State state);
108
109protected:
110 QModbusDevice(QModbusDevicePrivate &dd, QObject *parent = nullptr);
111
112 void setState(QModbusDevice::State newState);
113 void setError(const QString &errorText, QModbusDevice::Error error);
114 virtual bool open() = 0;
115 virtual void close() = 0;
116};
117
118Q_DECLARE_TYPEINFO(QModbusDevice::Error, Q_PRIMITIVE_TYPE);
119Q_DECLARE_TYPEINFO(QModbusDevice::State, Q_PRIMITIVE_TYPE);
120Q_DECLARE_TYPEINFO(QModbusDevice::ConnectionParameter, Q_PRIMITIVE_TYPE);
121
122QT_END_NAMESPACE
123
124#endif // QMODBUSDEVICE_H
125

Warning: That file was not part of the compilation database. It may have many parsing errors.

source code of qtserialbus/src/serialbus/qmodbusdevice.h