One Framework 0.1.0
RoboMaster嵌入式框架“一键”解决方案，为你的“创意”服务。
载入中...
搜索中...
未找到
Public 成员函数 | 成员变量 | Protected 成员函数
Unit类 参考abstract

单元基类，定义了单元的基本行为和属性。 更多...

#include <Unit.hpp>

Unit 的协作图:

Public 成员函数

void init ()
 
virtual void run ()=0
 单元的主运行函数。
 
void cleanup ()
 清理单元资源。
 
constexpr std::string_view getName () const
 
constexpr std::string_view getDescription () const
 
constexpr size_t getStackSize () const
 
constexpr uint8_t getPriority () const
 
constexpr uint32_t getTypeId () const
 
virtual const UnitTypeDescriptor & typeDescriptor () const =0
 
void tryStop ()
 
bool shouldRun () const
 
virtual ~Unit ()
 单元的虚析构函数。
 

成员变量

UnitState state {UNINITIALIZED}
 
UnitRuntimeInfo stats {}
 

Protected 成员函数

virtual void initCustom ()
 
virtual void cleanupCustom ()
 

详细描述

单元基类，定义了单元的基本行为和属性。

单元是框架中可独立运行的组件，通常拥有自己的线程。 派生类需要实现纯虚函数，并可以通过静态成员函数提供默认配置。

构造及析构函数说明

◆ ~Unit()

~Unit ( )
virtualdefault

单元的虚析构函数。

Unit 类的析构函数默认实现。

成员函数说明

◆ cleanup()

void cleanup ( )
inline

清理单元资源。

此方法在单元线程停止后被调用，用于释放资源和执行清理操作。 派生类可以重写此方法。

◆ cleanupCustom()

virtual void cleanupCustom ( )
inlineprotectedvirtual

◆ getDescription()

std::string_view getDescription ( ) const
inlineconstexpr

◆ getName()

std::string_view getName ( ) const
inlineconstexpr

◆ getPriority()

uint8_t getPriority ( ) const
inlineconstexpr

◆ getStackSize()

size_t getStackSize ( ) const
inlineconstexpr

◆ getTypeId()

uint32_t getTypeId ( ) const
inlineconstexpr

◆ init()

void init ( )
inline

◆ initCustom()

virtual void initCustom ( )
inlineprotectedvirtual

◆ run()

virtual void run ( )
pure virtual

单元的主运行函数。

此方法在单元线程中循环执行，直到 shouldStop 标志被设置为 true。 派生类必须实现此方法。

◆ shouldRun()

bool shouldRun ( ) const
inline

◆ tryStop()

void tryStop ( )
inline

◆ typeDescriptor()

virtual const UnitTypeDescriptor & typeDescriptor ( ) const
pure virtual

结构体成员变量说明

◆ state

UnitState state {UNINITIALIZED}

◆ stats

UnitRuntimeInfo stats {}
该类的文档由以下文件生成: