roboctrl::device::referee类 参考

详细描述

RM source-profile referee device; raw serial transport, no control policy.

在文件 referee.h 第 16 行定义.

#include <referee.h>

类 roboctrl::device::referee 继承关系图:

roboctrl::device::referee 的协作图:

类
struct	info_type

Public 成员函数
bool	init (const info_type &info)
void	connect ()
void	start ()
awaitable< void >	task ()
bool	configured () const
bool	offline () const
auto	timeout () const
const referee_protocol::state &	data () const
std::string	desc () const
void	set_ui_status (referee_protocol::ui_status status)
void	on_frame (std::function< void(const referee_protocol::frame &)> callback)
void	receive (referee_protocol::bytes data)
awaitable< void >	send_graphics (std::span< const referee_protocol::graphic > items)
awaitable< void >	send_text (referee_protocol::graphic item, std::string_view text)
awaitable< void >	delete_graphics (std::uint8_t operation, std::uint8_t layer)
Public 成员函数 继承自 roboctrl::utils::singleton_base< referee >
	singleton_base (const singleton_base &)=delete
singleton_base &	operator= (const singleton_base &)=delete
Public 成员函数 继承自 roboctrl::utils::immovable_base
	immovable_base (immovable_base &&)=delete
immovable_base &	operator= (immovable_base &&)=delete
Public 成员函数 继承自 roboctrl::utils::not_copyable_base
	not_copyable_base (const not_copyable_base &)=delete
not_copyable_base &	operator= (const not_copyable_base &)=delete

额外继承的成员函数
静态 Public 成员函数 继承自 roboctrl::utils::singleton_base< referee >
static referee &	instance ()
	获取单例实例
Protected 成员函数 继承自 roboctrl::log::logable< referee >
void	log (log_level level, std::format_string< Args... > fmt, Args &&...args) const
	输出日志
void	log_debug (std::format_string< Args... > fmt, Args &&...args) const
	输出debug日志
void	log_info (std::format_string< Args... > fmt, Args &&...args) const
	输出info日志
void	log_warn (std::format_string< Args... > fmt, Args &&...args) const
	输出warn日志
void	log_error (std::format_string< Args... > fmt, Args &&...args) const
	输出error日志

成员函数说明

configured()

bool roboctrl::device::referee::configured ( ) const

inline

在文件 referee.h 第 30 行定义.

connect()

void referee::connect

(

)

在文件 referee.cpp 第 17 行定义.

data()

const referee_protocol::state & roboctrl::device::referee::data ( ) const

inline

在文件 referee.h 第 33 行定义.

delete_graphics()

awaitable< void > referee::delete_graphics	(	std::uint8_t	operation,
		std::uint8_t	layer
	)

在文件 referee.cpp 第 61 行定义.

desc()

std::string roboctrl::device::referee::desc ( ) const

inline

在文件 referee.h 第 34 行定义.

init()

bool referee::init

(

const info_type &

info

)

在文件 referee.cpp 第 8 行定义.

offline()

bool referee::offline

(

)

const

在文件 referee.cpp 第 30 行定义.

on_frame()

void roboctrl::device::referee::on_frame ( std::function< void(const referee_protocol::frame &)>  callback )

inline

All CRC-validated frames can be observed, including unsupported command IDs.

在文件 referee.h 第 37 行定义.

receive()

void referee::receive

(

referee_protocol::bytes

data

)

Feed bytes without opening hardware; used by the raw serial callback.

在文件 referee.cpp 第 34 行定义.

send_graphics()

awaitable< void > referee::send_graphics

(

std::span< const referee_protocol::graphic >

items

)

在文件 referee.cpp 第 49 行定义.

send_text()

awaitable< void > referee::send_text	(	referee_protocol::graphic	item,
		std::string_view	text
	)

在文件 referee.cpp 第 55 行定义.

set_ui_status()

void roboctrl::device::referee::set_ui_status ( referee_protocol::ui_status  status )

inline

在文件 referee.h 第 35 行定义.

start()

void referee::start

(

)

在文件 referee.cpp 第 24 行定义.

task()

awaitable< void > referee::task

(

)

在文件 referee.cpp 第 67 行定义.

timeout()

auto roboctrl::device::referee::timeout ( ) const

inline

在文件 referee.h 第 32 行定义.

---

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

• /home/runner/work/GKD.RoboCtrl/GKD.RoboCtrl/include/device/referee/referee.h
• device/referee/referee.cpp