AbstractComm Class

Member Function Documentation

[protected] AbstractComm::AbstractComm()

Default constructs an instance of AbstractComm.

[pure virtual slot] void AbstractComm::close()

关闭外部设备连接操作

[protected] void AbstractComm::close(QIODevice *device)

默认的关闭串口/网络操作 提供统一的关闭操作，供子类调用，若子类对关闭操作没有特殊的要求，那么不需要重写关闭操作

[signal] void AbstractComm::codeMayMessed()

[pure virtual slot] void AbstractComm::init()

初始化串口/网络，设计串口都是工作在子线程中，因此需要通过信号槽方式， 在子线程中运行初始化函数

[virtual] bool AbstractComm::isStarted()

返回当前串口/网络设备是否正在运行的标志位

example:

AbstractComm *ac = new ImplComm;
ac->openDevice("device");  // 打开设备
ac->isStarted();  // true
ac->close();
ac->isStarted();  // false

Note: Getter function for property started.

[pure virtual protected slot] void AbstractComm::onRead()

读取操作，若运行在子线程的循环中，需要显式调用 Qt 的事件分发， 避免子线程无法关闭。

See also AbstractComm::readDevice(QIODevice *device).

[pure virtual slot] void AbstractComm::openComm(const QString &name)

根据串口/网络名称，打开新的串口/网络

example:

AbstractComm *cfd = new ImplComm1;
cfd->openComm("COM1");  // 打开串口

[signal] void AbstractComm::recvLine(const QByteArray &data)

从串口/网络等设备中接收到的一行数据。 行结束符为 LineSeparator

[signal] void AbstractComm::recvRawData(const QByteArray &data)

从串口/网络等设备中接收到的数据，该数据是一行数据中的一部分。

[signal] void AbstractComm::sendData(const QByteArray &data)

表示数据已经发送到外部设备中

[pure virtual slot] void AbstractComm::setCommProperty(const QString &key, const QVariant &value)

键和值需要参考 QSerialPort 的 Property 设置串口属性（波特率，停止位等）、网络属性（地址）等

example: AbstractComm *cfd = new ImplComm1; cfd->setCommProperty("baudRate", 2400); // 设置波特率为 2400 cfd->setCommProperty("dataBit", 0); // 设置数据位为 8

[virtual] void AbstractComm::setStarted(const bool started)

设置标志位，表示串口/网络设备是否可以运行（由控制器设置，但实现类可忽略该标志位）

example:

AbstractComm *ac = new ImplComm;
ac->setStarted(true);  // 设置标志位
ac->isStarted();  // true

Note: you need to have the flag set when opening a device by default. or the manager may not set the flag to false.

AbstractComm *ac = new ImplComm;
ac->openDevice("COM1");
ac->isStarted();  // true

Note: Setter function for property started.

See also isStarted() and AbstractComm::openDevice.

void AbstractComm::setState(const CommState &state)

设置状态，注意，所有的子类都共享抽象类里的 static 内存区域， 对某个子类的 state 进行修改，会影响到其它所有的子类。

example:

AbstractComm *cfd = new ImplComm1;

CommState s1 = cfd->state();
qDebug() << s1; // { "COM1", 9600, false, "" }

s1.baudRate = 38400;
cfd->setState(s1);

AbstractComm *chd = new ImplComm1;
CommState s2 = cfd->state();
qDebug() << s2; // { "COM1", 38400, false, "" }

See also AbstractComm::state().

CommState &AbstractComm::state()

See also setState().

[signal] void AbstractComm::stateChanged(const CommState &serial)

[pure virtual slot] void AbstractComm::write(const QByteArray &rawdata)

This is a funciton that actually performs the communication it receives raw string and send it into serial port 将文本数据写入到串口 原始的文本数据

See also AbstractComm::writeData(QIODevice *device, const QByteArray &rawdata) and ;.

[protected] void AbstractComm::writeData(QIODevice *device, const QByteArray &rawdata)

默认的写串口操作

在 rawdata 末尾添加回车换行符, 将 rawdata 发送至串口

example:

// Assume that content of a command is "#ALARM=1*ff"
// in class ImplComm
writeData(m_device, content);  // then the content will be send into the device (MCU) by SerialPort/Network