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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
/****************************************************************************
**
** Copyright (C) 2017 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 "qmodbusdataunit.h"
QT_BEGIN_NAMESPACE
/*!
\class QModbusDataUnit
\inmodule QtSerialBus
\since 5.8
\brief QModbusDataUnit is a container class representing single bit and
\c 16 bit word entries in the Modbus register.
\l QModbusDataUnit can be used for read and write operations. The entries
are addressed via \l startAddress() and the \l valueCount() number of
contiguous entries. \l registerType() determines which register is used for
the operations. Note that some registers are read-only registers.
The actual \l values() are either single bit or \c 16 bit based.
\l QModbusDataUnit::DiscreteInputs and \l QModbusDataUnit::Coils
only accept single bits. Therefore \c 0 is interpreted as \c 0 and anything
else \c 1.
*/
/*!
\enum QModbusDataUnit::RegisterType
This enum describes all supported register types.
\value Invalid Set by the default constructor, do not use.
\value DiscreteInputs This type of data can be provided by an I/O
system.
\value Coils This type of data can be alterable by an
application program.
\value InputRegisters This type of data can be provided by an I/O
system.
\value HoldingRegisters This type of data can be alterable by an
application program.
*/
/*!
\fn QModbusDataUnit::QModbusDataUnit()
Constructs an empty, invalid QModbusDataUnit. Start address is set to \c -1
and the \l registerType is set to \l QModbusDataUnit::Invalid.
*/
/*!
\fn QModbusDataUnit::QModbusDataUnit(RegisterType type)
Constructs a unit of data for register \a type. Start address is set to
\c 0, data range and data values are empty.
*/
/*!
\fn QModbusDataUnit::QModbusDataUnit(RegisterType type, int address,
quint16 size)
Constructs a unit of data for register\a type. Start address of the data is
set to \a address and the size of the unit to \a size.
The entries of \l values() are initialized with \c 0.
*/
/*!
\fn QModbusDataUnit::QModbusDataUnit(RegisterType type, int address,
const QVector<quint16> &data)
Constructs a unit of data for register\a type. Start address of the data is
set to \a address and the unit's values to \a data.
The value count is implied by the \a data size.
*/
/*!
\fn void QModbusDataUnit::setRegisterType(QModbusDataUnit::RegisterType type)
Sets the register \a type.
\sa registerType(), QModbusDataUnit::RegisterType
*/
/*!
\fn QModbusDataUnit::RegisterType QModbusDataUnit::registerType() const
Returns the type of the register.
\sa setRegisterType(), QModbusDataUnit::RegisterType
*/
/*!
\fn void QModbusDataUnit::setStartAddress(int address)
Sets the start \a address of the data unit.
\sa startAddress()
*/
/*!
\fn int QModbusDataUnit::startAddress() const
Returns the start address of data unit in the register.
\sa setStartAddress()
*/
/*!
\fn void QModbusDataUnit::setValues(const QVector<quint16> &values)
Sets the \a values of the data unit. \l QModbusDataUnit::DiscreteInputs
and \l QModbusDataUnit::Coils tables only accept single bit value, so \c 0
is interpreted as \c 0 and anything else as \c 1.
\sa values()
*/
/*!
\fn QVector<quint16> QModbusDataUnit::values() const
Returns the data in the data unit. \l QModbusDataUnit::DiscreteInputs
and \l QModbusDataUnit::Coils tables only accept single bit value, so \c 0
is interpreted as \c 0 and anything else as \c 1.
\sa setValues()
*/
/*!
\fn uint QModbusDataUnit::valueCount() const
Returns the size of the requested register's data block or the size of data
read from the device.
This function may not always return a count that equals \l values() size.
Since this class is used to request data from the remote data register, the
\l valueCount() can be used to indicate the size of the requested register's
data block. Once the request has been processed, the \l valueCount() is
equal to the size of \l values().
\sa setValueCount()
*/
/*!
\fn void QModbusDataUnit::setValueCount(uint newCount)
Sets the size of the requested register's data block to \a newCount.
This may be different from \l values() size as this function is used
to indicated the size of a data request. Only once the data request
has been processed \l valueCount() is equal to the size of \l values().
*/
/*!
\fn void QModbusDataUnit::setValue(int index, quint16 value)
Sets the register at position \a index to \a value.
*/
/*!
\fn quint16 QModbusDataUnit::value(int index) const
Return the value at position \a index.
*/
/*!
\fn bool QModbusDataUnit::isValid() const
Returns \c true if the \c QModbusDataUnit is valid; otherwise \c false.
A \c QModbusDataUnit is considered valid if the \l registerType() is not
\l QModbusDataUnit::Invalid and the \l startAddress() is greater than or
equal to \c 0.
*/
/*!
\typedef QModbusDataUnitMap
\relates QModbusDataUnit
\since 5.8
Synonym for QMap<QModbusDataUnit::RegisterType, QModbusDataUnit>.
*/
QT_END_NAMESPACE
|
