QModbusDataUnit Class

QModbusDataUnit is a container class representing single bit and 16 bit word entries in the Modbus register. 更多...

头文件: #include <QModbusDataUnit>
qmake: QT += serialbus
开始支持版本: Qt 5.8

公有类型

enum RegisterType { Invalid, DiscreteInputs, Coils, InputRegisters, HoldingRegisters }

公有函数

QModbusDataUnit() = default
QModbusDataUnit(RegisterType type)
QModbusDataUnit(RegisterType type, int address, quint16 size)
QModbusDataUnit(RegisterType type, int address, const QVector<quint16> &data)
bool isValid() const
RegisterType registerType() const
void setRegisterType(RegisterType type)
void setStartAddress(int address)
void setValue(int index, quint16 value)
void setValueCount(uint newCount)
void setValues(const QVector<quint16> &values)
int startAddress() const
quint16 value(int index) const
uint valueCount() const
QVector<quint16> values() const

详细描述

QModbusDataUnit is a container class representing single bit and 16 bit word entries in the Modbus register.

QModbusDataUnit can be used for read and write operations. The entries are addressed via startAddress() and the valueCount() number of contiguous entries. registerType() determines which register is used for the operations. Note that some registers are read-only registers.

The actual values() are either single bit or 16 bit based. QModbusDataUnit::DiscreteInputs and QModbusDataUnit::Coils only accept single bits. Therefore 0 is interpreted as 0 and anything else 1.

成员类型

enum QModbusDataUnit::RegisterType

This enum describes all supported register types.

ConstantValueDescription
QModbusDataUnit::Invalid0Set by the default constructor, do not use.
QModbusDataUnit::DiscreteInputs1This type of data can be provided by an I/O system.
QModbusDataUnit::Coils2This type of data can be alterable by an application program.
QModbusDataUnit::InputRegisters3This type of data can be provided by an I/O system.
QModbusDataUnit::HoldingRegisters4This type of data can be alterable by an application program.

成员函数

[default] QModbusDataUnit::QModbusDataUnit()

Constructs an empty, invalid QModbusDataUnit. Start address is set to -1 and the registerType is set to QModbusDataUnit::Invalid.

QModbusDataUnit::QModbusDataUnit(RegisterType type)

Constructs a unit of data for register type. Start address is set to 0, data range and data values are empty.

QModbusDataUnit::QModbusDataUnit(RegisterType type, int address, quint16 size)

Constructs a unit of data for registertype. Start address of the data is set to address and the size of the unit to size. The entries of values() are initialized with 0.

QModbusDataUnit::QModbusDataUnit(RegisterType type, int address, const QVector<quint16> &data)

Constructs a unit of data for registertype. Start address of the data is set to address and the unit's values to data. The value count is implied by the data size.

bool QModbusDataUnit::isValid() const

Returns true if the QModbusDataUnit is valid; otherwise false. A QModbusDataUnit is considered valid if the registerType() is not QModbusDataUnit::Invalid and the startAddress() is greater than or equal to 0.

RegisterType QModbusDataUnit::registerType() const

Returns the type of the register.

参见 setRegisterType() and QModbusDataUnit::RegisterType.

void QModbusDataUnit::setRegisterType(RegisterType type)

Sets the register type.

参见 registerType() and QModbusDataUnit::RegisterType.

void QModbusDataUnit::setStartAddress(int address)

Sets the start address of the data unit.

参见 startAddress().

void QModbusDataUnit::setValue(int index, quint16 value)

Sets the register at position index to value.

参见 value().

void QModbusDataUnit::setValueCount(uint newCount)

Sets the size of the requested register's data block to newCount.

This may be different from values() size as this function is used to indicated the size of a data request. Only once the data request has been processed valueCount() is equal to the size of values().

参见 valueCount().

void QModbusDataUnit::setValues(const QVector<quint16> &values)

Sets the values of the data unit. QModbusDataUnit::DiscreteInputs and QModbusDataUnit::Coils tables only accept single bit value, so 0 is interpreted as 0 and anything else as 1.

参见 values().

int QModbusDataUnit::startAddress() const

Returns the start address of data unit in the register.

参见 setStartAddress().

quint16 QModbusDataUnit::value(int index) const

Return the value at position index.

参见 setValue().

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 values() size. Since this class is used to request data from the remote data register, the valueCount() can be used to indicate the size of the requested register's data block. Once the request has been processed, the valueCount() is equal to the size of values().

参见 setValueCount().

QVector<quint16> QModbusDataUnit::values() const

Returns the data in the data unit. QModbusDataUnit::DiscreteInputs and QModbusDataUnit::Coils tables only accept single bit value, so 0 is interpreted as 0 and anything else as 1.

参见 setValues().

相关非成员

typedef QModbusDataUnitMap

Synonym for QMap<QModbusDataUnit::RegisterType, QModbusDataUnit>.

This typedef was introduced in Qt 5.8.