BitbotEncos
Bitbot Encos is a bitbot instance for encos motor.
载入中...
搜索中...
未找到
bitbot::Encos_CANBusDevice类 参考abstract

Encos总线设备类,继承自EncosDevice, 用户可以使用该类来管理Encos总线设备。 该类型仅适用于开发者使用,用户无需关心其实现细节。该类型设备是指实际挂载在EtherCAT总线上的设备。 更多...

#include <Encos_device.hpp>

类 bitbot::Encos_CANBusDevice 继承关系图:
bitbot::Encos_CANBusDevice 的协作图:

Public 成员函数

 Encos_CANBusDevice (const pugi::xml_node &device_node)
 构造函数
 
virtual ~Encos_CANBusDevice ()=default
 析构函数
 
- Public 成员函数 继承自 bitbot::EncosDevice
 EncosDevice (const pugi::xml_node &device_node)
 构造函数
 
virtual void UpdateRuntimeData ()=0
 更新运行时数据,该函数会被内核周期性调用。
 

Protected 成员函数

virtual size_t get_EtherCAT_Slave_ID () const =0
 获取EtherCAT从站ID
 
virtual void get_CAN_IDs (std::vector< size_t > &ids) const =0
 获取EtherCAT转CAN总线的设备ID
 
virtual void ReadBus (const CAN_Device_Msg &data)=0
 进行一次读取操作,开发者需要在该函数中实现自己的读取逻辑。该函数会被总线管理器周期性调用。
 
virtual void WriteBus (CAN_Device_Msg &data)=0
 进行一次写入操作,开发者需要在该函数中实现自己的写入逻辑。该函数会被总线管理器周期性调用。
 
virtual constexpr bool VirtualBusDevice () const final override
 判断设备是否为虚拟总线设备,虚拟总线设备是指未实际挂载在EtherCAT总线上,但也需要进行数据交换的设备。
 
- Protected 成员函数 继承自 bitbot::EncosDevice
virtual bool PowerOn ()
 默认的上电函数,开发者可以在该函数中实现自己的上电逻辑。
 
virtual bool HasPowerCfg ()
 判断设备是否有上电配置,开发者可以根据设备类型的实际情况实现该函数。
 
virtual bool PowerOff ()
 默认的下电函数,开发者可以在该函数中实现自己的下电逻辑。
 

友元

class EncosBus
 

详细描述

Encos总线设备类,继承自EncosDevice, 用户可以使用该类来管理Encos总线设备。 该类型仅适用于开发者使用,用户无需关心其实现细节。该类型设备是指实际挂载在EtherCAT总线上的设备。

构造及析构函数说明

◆ Encos_CANBusDevice()

bitbot::Encos_CANBusDevice::Encos_CANBusDevice ( const pugi::xml_node & device_node)
inline

构造函数

构造函数,该函数由Bitbot Encos内核创建。

参数
device_node设备节点的配置文件

◆ ~Encos_CANBusDevice()

virtual bitbot::Encos_CANBusDevice::~Encos_CANBusDevice ( )
virtualdefault

析构函数

析构函数。设备的生命期由Bitbot Encos内核管理,开发者无需关心设备生命周期。

成员函数说明

◆ get_CAN_IDs()

virtual void bitbot::Encos_CANBusDevice::get_CAN_IDs ( std::vector< size_t > & ids) const
protectedpure virtual

获取EtherCAT转CAN总线的设备ID

参数
ids设备ID列表。一个设备可以有多个CAN总线ID。

◆ get_EtherCAT_Slave_ID()

virtual size_t bitbot::Encos_CANBusDevice::get_EtherCAT_Slave_ID ( ) const
protectedpure virtual

获取EtherCAT从站ID

返回
size_t 从站ID

◆ ReadBus()

virtual void bitbot::Encos_CANBusDevice::ReadBus ( const CAN_Device_Msg & data)
protectedpure virtual

进行一次读取操作,开发者需要在该函数中实现自己的读取逻辑。该函数会被总线管理器周期性调用。

参数
data读取的数据

◆ VirtualBusDevice()

virtual constexpr bool bitbot::Encos_CANBusDevice::VirtualBusDevice ( ) const
inlineconstexprfinaloverrideprotectedvirtual

判断设备是否为虚拟总线设备,虚拟总线设备是指未实际挂载在EtherCAT总线上,但也需要进行数据交换的设备。

返回
true
false

实现了 bitbot::EncosDevice.

◆ WriteBus()

virtual void bitbot::Encos_CANBusDevice::WriteBus ( CAN_Device_Msg & data)
protectedpure virtual

进行一次写入操作,开发者需要在该函数中实现自己的写入逻辑。该函数会被总线管理器周期性调用。

参数
data写入的数据

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