QCanSignalDescription Class

QCanSignalDescription signal1;
signal1.setDataEndian(QSysInfo::Endian::LittleEndian);
signal1.setStartBit(0);
signal1.setBitLength(12);
// other parameters for signal1

QCanSignalDescription signal2;
signal2.setDataEndian(QSysInfo::Endian::LittleEndian);
signal2.setStartBit(12);
signal2.setBitLength(12);
// other parameters for signal2

QCanSignalDescription signal1;
signal1.setDataEndian(QSysInfo::Endian::BigEndian);
signal1.setStartBit(7);
signal1.setBitLength(12);
// other parameters for signal1

QCanSignalDescription signal2;
signal2.setDataEndian(QSysInfo::Endian::BigEndian);
signal2.setStartBit(11);
signal2.setBitLength(12);
// other parameters for signal2

physicalValue = scaling * (signalValue * factor + offset);
signalValue = (physicalValue / scaling - offset) / factor;

成员函数文档

QCanSignalDescription::QCanSignalDescription()

创建一个空的信号描述。

QCanSignalDescription::QCanSignalDescription(const QCanSignalDescription &other)

使用从other 复制的值创建信号描述。

[noexcept] QCanSignalDescription::QCanSignalDescription(QCanSignalDescription &&other)

通过移动other 创建信号描述。

[noexcept] QCanSignalDescription::~QCanSignalDescription()

销毁该信号描述。

void QCanSignalDescription::addMultiplexSignal(const QString &name, const QCanSignalDescription::MultiplexValues &ranges)

为该信号添加新的multiplexor signal 。name 参数包含多路复用器信号的名称，ranges 参数包含预期值范围。

如果多路复用器信号name 已有预期值范围，则这些范围将被覆盖。

另请参阅 multiplexState()、multiplexSignals()、clearMultiplexSignals() 和setMultiplexSignals() 。

void QCanSignalDescription::addMultiplexSignal(const QString &name, const QVariant &value)

这是一个重载函数。

这是一个方便的重载函数，适用于只期望多路复用器信号具有一个特定值而不是一系列值的情况。

name 参数包含多路复用器信号的名称，value 参数包含期望值。

如果多路复用器信号name 已有预期值范围，该信号的预期值范围将被覆盖。

另请参阅 multiplexState()、multiplexSignals()、clearMultiplexSignals() 和setMultiplexSignals() 。

quint16 QCanSignalDescription::bitLength() const

返回信号值的位长。

另请参阅 setBitLength()、startBit() 和setStartBit()。

void QCanSignalDescription::clearMultiplexSignals()

删除该信号的所有multiplexor signals 。

另请参阅 multiplexSignals()、setMultiplexSignals() 和addMultiplexSignal()。

QString QCanSignalDescription::comment() const

返回信号的注释。

该参数仅用于额外说明。在信号处理过程中不会使用。

另请参见 setComment().

QSysInfo::Endian QCanSignalDescription::dataEndian() const

返回信号值的数据 endian。

默认使用BigEndian 。

另请参阅 setDataEndian() 和QSysInfo::Endian 。

QtCanBus::DataFormat QCanSignalDescription::dataFormat() const

返回信号值的数据格式。

默认使用SignedInteger 。

另请参阅 setDataFormat() 和QtCanBus::DataFormat 。

QtCanBus::DataSource QCanSignalDescription::dataSource() const

返回信号值的数据源。

默认使用Payload 。

另请参阅 setDataSource() 和QtCanBus::DataSource 。

double QCanSignalDescription::factor() const

返回用于将信号值转换为物理值的因子。

默认情况下，函数返回qQNaN() ，即不使用系数。

Value Conversions 部分将解释如何使用该参数。

另请参阅 setFactor()、offset() 和scaling()。

bool QCanSignalDescription::isValid() const

如果信号描述有效，则返回true ，否则返回false 。

有效的信号描述必须满足以下条件：

• 有一个非空的name()
• 如果dataFormat() 是，则有bitLength()== 32 Float
• 有bitLength()== 64 ，如果dataFormat() 是Double
• bitLength()必须是8 的倍数，如果dataFormat() 是AsciiString
• 则bitLength()必须大于0 ，小于或等于64 。

另请参见 bitLength()、dataFormat() 和name()。

double QCanSignalDescription::maximum() const

返回信号的最大支持值。

默认情况下，函数返回qQNaN() ，即没有最大值。

另请参阅 setRange() 和minimum()。

double QCanSignalDescription::minimum() const

返回信号的最小支持值。

默认情况下，函数返回qQNaN() ，即没有最小值。

另请参阅 setRange() 和maximum()。

QCanSignalDescription::MultiplexSignalValues QCanSignalDescription::multiplexSignals() const

返回用于正确标识该信号的multiplexor signals 及其期望值。

返回的哈希值包含作为键的信号名称和作为值的各自期望值范围。

只有当散列中的所有信号都具有预期值时，才能从有效负载中提取该信号的值。

另请参见 multiplexState()、clearMultiplexSignals()、setMultiplexSignals() 和addMultiplexSignal()。

QtCanBus::MultiplexState QCanSignalDescription::multiplexState() const

返回信号的多路复用状态。

有关多路复用信号的更多详情，请参阅Multiplexed Signals Explained 部分。

默认情况下，该方法返回None 。

另请参阅 setMultiplexState() 和QtCanBus::MultiplexState 。

QString QCanSignalDescription::name() const

返回信号的名称。

另请参阅 setName() 和isValid()。

double QCanSignalDescription::offset() const

返回用于将信号值转换为物理值的偏移量。

默认情况下，函数返回qQNaN() 表示不使用偏移量。

Value Conversions 部分将解释如何使用该参数。

另请参阅 setOffset()、factor() 和scaling()。

QString QCanSignalDescription::physicalUnit() const

返回信号值的物理单位（如 km/h），如果未设置单位，则返回空字符串。

该参数仅用于额外说明。在信号处理过程中不会使用。

另请参阅 setPhysicalUnit().

QString QCanSignalDescription::receiver() const

返回该信号的接收节点。

该参数仅用于额外说明。在信号处理过程中不会使用。

另请参见 setReceiver()。

double QCanSignalDescription::scaling() const

返回将信号值转换为物理值时使用的缩放。

默认情况下，函数返回qQNaN() 表示不使用缩放。

Value Conversions 部分将解释如何使用该参数。

另请参阅 setScaling()、offset() 和factor()。

void QCanSignalDescription::setBitLength(quint16 length)

将信号值的位长设置为length 。

另请参阅 bitLength()、startBit() 和setStartBit()。

void QCanSignalDescription::setComment(const QString &text)

将信号的注释设置为text 。

该参数仅用于额外说明。在信号处理过程中不会使用。

另请参阅 comment() 。

void QCanSignalDescription::setDataEndian(QSysInfo::Endian endian)

将信号值的数据字节序设置为endian 。

另请参见 dataEndian() 和QSysInfo::Endian 。

void QCanSignalDescription::setDataFormat(QtCanBus::DataFormat format)

将信号值的数据格式设置为format 。

另请参阅 dataFormat() 和QtCanBus::DataFormat 。

void QCanSignalDescription::setDataSource(QtCanBus::DataSource source)

将信号值的数据源设置为source 。

另请参阅 dataSource() 和QtCanBus::DataSource 。

void QCanSignalDescription::setFactor(double factor)

设置用于将信号值转换为物理值并返回factor 的因子。

向该方法传递qQNaN() 可在转换过程中跳过该参数。

系数不能为 0。试图设置零系数相当于将其设置为qQNaN()。

Value Conversions 部分解释了如何使用此参数。

另请参阅 factor()、setOffset() 和setScaling()。

void QCanSignalDescription::setMultiplexSignals(const QCanSignalDescription::MultiplexSignalValues &multiplexorSignals)

将此信号的multiplexor signals 设置为multiplexorSignals 。

multiplexorSignals 哈希值必须包含作为键的信号名称和作为值的各自所需值范围。

另请参阅 multiplexState()、multiplexSignals()、clearMultiplexSignals() 和addMultiplexSignal()。

void QCanSignalDescription::setMultiplexState(QtCanBus::MultiplexState state)

将信号的多路复用状态设置为state 。

有关多路复用信号的更多详情，请参阅Multiplexed Signals Explained 部分。

另请参阅 multiplexState() 和QtCanBus::MultiplexState 。

void QCanSignalDescription::setName(const QString &name)

将信号名称设置为name 。

信号名称在 CAN 报文中必须是唯一的。

另请参阅 name() 。

void QCanSignalDescription::setOffset(double offset)

设置偏移量，用于将信号值转换为物理值并返回offset 。

向该方法传递qQNaN() 可在转换过程中跳过该参数。

Value Conversions 部分将解释如何使用该参数。

另请参阅 offset()、setFactor() 和setScaling()。

void QCanSignalDescription::setPhysicalUnit(const QString &unit)

设置信号值的物理unit （例如 km/h）。

该参数仅用于额外说明。在信号处理过程中不会使用。

另请参阅 physicalUnit().

void QCanSignalDescription::setRange(double minimum, double maximum)

设置信号值的minimum 和maximum 。

将一个或两个参数设置为qQNaN() 意味着不使用相应的限值。

另请参阅 minimum() 和maximum()。

void QCanSignalDescription::setReceiver(const QString &receiver)

为该信号设置receiver 节点。

该参数仅用于额外说明。在信号处理过程中不会使用。

另请参阅 receiver().

void QCanSignalDescription::setScaling(double scaling)

设置将信号值转换为物理值并返回scaling 时使用的缩放比例。

向该方法传递qQNaN() 可在转换过程中跳过该参数。

缩放比例不能为 0。尝试设置零缩放比例相当于将其设置为qQNaN()。

Value Conversions 部分解释了如何使用该参数。

另请参阅 scaling()、setOffset() 和setFactor()。

void QCanSignalDescription::setStartBit(quint16 bit)

将dataSource() 中信号值的起始位设置为bit 。

另请参阅 startBit()、bitLength() 和setBitLength()。

quint16 QCanSignalDescription::startBit() const

返回dataSource() 中信号值的起始位。

另请参阅 setStartBit()、bitLength() 和setBitLength()。

[noexcept] QCanSignalDescription &QCanSignalDescription::operator=(QCanSignalDescription &&other)

移动--将other 中的值赋值给该信号描述。

QCanSignalDescription &QCanSignalDescription::operator=(const QCanSignalDescription &other)

将other 中的值分配给该信号描述。