Ctrl-Z
一个多线程机器人运动控制强化学习部署框架
载入中...
搜索中...
未找到
z::SimpleCallbackWorker< SchedulerType > 模板类 参考

SimpleCallbackWorker 类型是一个简单的回调工人类型,用户可以通过这个工人类型来实现一些简单的工作逻辑。 更多...

#include <AbstractWorker.hpp>

类 z::SimpleCallbackWorker< SchedulerType > 继承关系图:
z::SimpleCallbackWorker< SchedulerType > 的协作图:

Public 成员函数

 SimpleCallbackWorker (SchedulerType::Ptr scheduler, CallbackType func, const nlohmann::json &cfg=nlohmann::json())
 构造一个简单的回调工人类型
 
virtual ~SimpleCallbackWorker ()
 析构函数,虚函数,用于释放资源
 
virtual void TaskRun () override
 TaskRun方法,在每次任务队列循环中被调用,这个方法会调用用户传入的回调函数
 
nlohmann::json & getConfig ()
 获取配置文件
 
- 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::SimpleCallbackWorker< SchedulerType >

SimpleCallbackWorker 类型是一个简单的回调工人类型,用户可以通过这个工人类型来实现一些简单的工作逻辑。

SimpleCallbackWorker 类型是一个简单的回调工人类型,用户可以通过这个工人类型来实现一些简单的工作逻辑。 这个工人类型的优点是简单易用,用户只需要实现一个回调函数,就可以实现一个工人的工作逻辑,适用于一些简单的工作逻辑。 比如需要临时修改流水线中的一些数据,或者需要在流水线中插入一些简单的逻辑。

模板参数
SchedulerType调度器类型。

构造及析构函数说明

◆ SimpleCallbackWorker()

template<typename SchedulerType>
z::SimpleCallbackWorker< SchedulerType >::SimpleCallbackWorker ( SchedulerType::Ptr scheduler,
CallbackType func,
const nlohmann::json & cfg = nlohmann::json() )
inline

构造一个简单的回调工人类型

参数
scheduler调度器的指针
func回调函数,用户可以通过这个回调函数来实现工人的工作逻辑,该函数在TaskRun方法中被调用
cfg配置文件,用户可以通过配置文件来配置工人的一些参数。

成员函数说明

◆ getConfig()

template<typename SchedulerType>
nlohmann::json & z::SimpleCallbackWorker< SchedulerType >::getConfig ( )
inline

获取配置文件

返回
配置文件

◆ TaskRun()

template<typename SchedulerType>
virtual void z::SimpleCallbackWorker< SchedulerType >::TaskRun ( )
inlineoverridevirtual

TaskRun方法,在每次任务队列循环中被调用,这个方法会调用用户传入的回调函数

实现了 z::AbstractWorker< SchedulerType >.


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