rm::SerialPort类 参考

串行接口通信库 更多...

#include <rmvl/core/io.hpp>

rm::SerialPort 的协作图:

Public 成员函数
	SerialPort (std::string_view device, SerialPortMode mode={})
	构造新 SerialPort 对象
	SerialPort (const SerialPort &)=delete
	SerialPort (SerialPort &&)=default
SerialPort &	operator= (const SerialPort &)=delete
SerialPort &	operator= (SerialPort &&)=default
template<typename Tp , typename Enable = std::enable_if_t<std::is_aggregate_v<Tp>>>
bool	read (unsigned char head_flag, unsigned char tail_flag, Tp &data)
	从串口读取数据到聚合体中
template<typename Tp , typename Enable = std::enable_if_t<std::is_aggregate_v<Tp>>>
bool	read (Tp &data)
	不带头尾标志的数据读取，从串口读取数据到聚合体中
bool	read (std::string &data)
	不带头尾标志的数据读取，从串口读取字符串
template<typename Tp , typename Enable = std::enable_if_t<std::is_aggregate_v<Tp> || std::is_same_v<Tp, std::string>>>
SerialPort &	operator>> (Tp &data)
template<typename Tp , typename Enable = std::enable_if_t<std::is_aggregate_v<Tp>>>
bool	write (const Tp &data)
	数据写入串口
bool	write (std::string_view data)
	写入字符串到串口
template<typename Tp , typename Enable = std::enable_if_t<std::is_aggregate_v<Tp> || std::is_same_v<Tp, std::string_view>>>
SerialPort &	operator<< (const Tp &data)
bool	isOpened () const
	串口是否打开

详细描述

串行接口通信库

构造及析构函数说明

SerialPort() [1/3]

rm::SerialPort::SerialPort	(	std::string_view	device,
		SerialPortMode	mode = {} )

Python:
	rm.SerialPort(	device[, mode]	) ->	<SerialPort object>

构造新 SerialPort 对象

参数

[in]	device	设备名
[in]	mode	串口通信模式

SerialPort() [2/3]

rm::SerialPort::SerialPort ( const SerialPort & )

delete

Python:
	rm.SerialPort(	device[, mode]	) ->	<SerialPort object>

SerialPort() [3/3]

rm::SerialPort::SerialPort ( SerialPort && )

default

Python:
	rm.SerialPort(	device[, mode]	) ->	<SerialPort object>

成员函数说明

isOpened()

bool rm::SerialPort::isOpened

(

)

const

串口是否打开

operator<<()

template<typename Tp , typename Enable = std::enable_if_t<std::is_aggregate_v<Tp> || std::is_same_v<Tp, std::string_view>>>

SerialPort & rm::SerialPort::operator<< ( const Tp & data )

inline

operator=() [1/2]

SerialPort & rm::SerialPort::operator= ( const SerialPort & )

delete

operator=() [2/2]

SerialPort & rm::SerialPort::operator= ( SerialPort && )

default

operator>>()

template<typename Tp , typename Enable = std::enable_if_t<std::is_aggregate_v<Tp> || std::is_same_v<Tp, std::string>>>

SerialPort & rm::SerialPort::operator>> ( Tp & data )

inline

read() [1/3]

bool rm::SerialPort::read

(

std::string &

data

)

Python:
	rm.SerialPort.read(		) ->	res, data

不带头尾标志的数据读取，从串口读取字符串

参数

[out]

data

读取的字符串

返回

是否读取成功

read() [2/3]

template<typename Tp , typename Enable = std::enable_if_t<std::is_aggregate_v<Tp>>>

bool rm::SerialPort::read ( Tp & data )

inline

Python:
	rm.SerialPort.read(		) ->	res, data

不带头尾标志的数据读取，从串口读取数据到聚合体中

模板参数

Tp

读取到聚合体的类型

参数

[out]

data

读取的聚合体数据

返回

是否读取成功

read() [3/3]

template<typename Tp , typename Enable = std::enable_if_t<std::is_aggregate_v<Tp>>>

bool rm::SerialPort::read ( unsigned char head_flag, unsigned char tail_flag, Tp & data )

inline

Python:
	rm.SerialPort.read(		) ->	res, data

从串口读取数据到聚合体中

注解

每次读取后会清空缓冲区

模板参数

Tp

读取到聚合体的类型

参数

[in]	head_flag	头帧
[in]	tail_flag	尾帧
[out]	data	读取的聚合体数据

返回

是否读取成功

write() [1/2]

template<typename Tp , typename Enable = std::enable_if_t<std::is_aggregate_v<Tp>>>

bool rm::SerialPort::write ( const Tp & data )

inline

Python:
	rm.SerialPort.write(	data	) ->	res

数据写入串口

注解

每次写入前会清空缓冲区

模板参数

Tp

写入聚合体的类型

参数

[in]

data

要写入的聚合体

返回

是否写入成功

write() [2/2]

bool rm::SerialPort::write ( std::string_view data )

inline

Python:
	rm.SerialPort.write(	data	) ->	res

写入字符串到串口

参数

[in]

data

待写入的字符串

返回

是否写入成功

---

该类的文档由以下文件生成:

• rmvl/core/io.hpp