z::KeyboardCommandWorker< SchedulerType > 模板类 参考

KeyboardCommandWorker 类型是一个键盘命令工人类型，用户可以通过这个工人类型来实现键盘命令的功能。 更多...

#include <KeyboardCommandWorker.hpp>

类 z::KeyboardCommandWorker< SchedulerType > 继承关系图:

z::KeyboardCommandWorker< SchedulerType > 的协作图:

Public 类型
using	KeyCallbackType = std::function<void(SchedulerType::Ptr)>
	键盘输入回调函数类型，函数签名为void(SchedulerType::Ptr)，包含一个调度器的指针

Public 成员函数
	KeyboardCommandWorker (SchedulerType::Ptr scheduler, const nlohmann::json &cfg=nlohmann::json())
	构造一个键盘命令工人类型
void	RegisterKeyCallback (char key, KeyCallbackType callback)
	注册一个键盘输入回调函数
void	TaskRun () override
	处理键盘输入的工作逻辑
Public 成员函数 继承自 z::AbstractWorker< SchedulerType >
	AbstractWorker (SchedulerType::Ptr scheduler, const nlohmann::json &cfg=nlohmann::json())
	构造一个抽象工人类型
void	setScheduler (SchedulerType::Ptr scheduler)
	设置调度器的指针
virtual	~AbstractWorker ()
	析构函数，虚函数，用于释放资源
virtual void	TaskCreate ()
	TaskCreate方法，在任务队列创建的时候会被调度器调用，用户可以在这个方法中初始化一些资源
virtual void	TaskDestroy ()
	TaskDestroy方法，在任务队列删除的时候会被调度器调用，用户可以在这个方法中释放一些资源
virtual void	TaskCycleBegin ()
	TaskCycleBegin方法，在每次任务队列循环的开始会被调度器调用。
virtual void	TaskCycleEnd ()
	TaskCycleEnd方法，在每次任务队列循环的结束会被调度器调用。
Public 成员函数 继承自 z::ZObject
void	PrintSplitLine (size_t length=60, char c='-')
	print a split line, default length is 60 and character is '-'

额外继承的成员函数
Protected 属性 继承自 z::AbstractWorker< SchedulerType >
SchedulerType::Ptr	Scheduler = nullptr
	调度器的指针，用户可以通过这个指针来获取一些全局的数据， 比如当前任务的时间戳，前级工人的输出数据等，也可以通过这个指针来设置一些全局的数据。

详细描述

template<typename SchedulerType>
class z::KeyboardCommandWorker< SchedulerType >

KeyboardCommandWorker 类型是一个键盘命令工人类型，用户可以通过这个工人类型来实现键盘命令的功能。

KeyboardCommandWorker 类型是一个键盘命令工人类型，用户可以通过这个工人类型来实现键盘命令的功能。 该类型会在TaskRun方法中检测键盘输入，并根据用户注册的回调函数来执行相应的操作。 用户可以通过注册回调函数来实现键盘输入的功能，比如用户可以通过注册回调函数来实现键盘输入的控制逻辑。 该类型适用于一些需要通过键盘输入来控制的场景，比如调试阶段的控制逻辑。

模板参数

SchedulerType

调度器类型

构造及析构函数说明

KeyboardCommandWorker()

template<typename SchedulerType>

z::KeyboardCommandWorker< SchedulerType >::KeyboardCommandWorker ( SchedulerType::Ptr scheduler, const nlohmann::json & cfg = nlohmann::json() )

inline

构造一个键盘命令工人类型

参数

scheduler	调度器的指针
cfg	配置文件

成员函数说明

RegisterKeyCallback()

template<typename SchedulerType>

void z::KeyboardCommandWorker< SchedulerType >::RegisterKeyCallback ( char key, KeyCallbackType callback )

inline

注册一个键盘输入回调函数

参数

key	绑定的按键
callback	回调函数，函数签名为void(SchedulerType::Ptr)

TaskRun()

template<typename SchedulerType>

void z::KeyboardCommandWorker< SchedulerType >::TaskRun ( )

inlineoverridevirtual

处理键盘输入的工作逻辑

实现了 z::AbstractWorker< SchedulerType >.

---

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

• C:/Users/ZhouZishun/Documents/Workspace/CtrlZ/CtrlZ/Workers/KeyboardCommandWorker.hpp