LidarMeasure/laser/LivoxLaser.puml

@startuml
skinparam classAttributeIconSize 0

title  CLivoxLaser




class CLivoxLaser
{
//大疆livox雷达，从Laser_base继承。
==protected:==
	//雷达设备状态，livox管理底层sdk，后台线程的工作状态
	typedef enum
	{
		kDeviceStateDisconnect = 0,		//雷达设备状态	断开连接
		kDeviceStateConnect = 1,		//雷达设备状态	连接正常
		kDeviceStateSampling = 2,		//雷达设备状态	正在扫描
	} DeviceState;
..
	//雷达设备信息，
	typedef struct
	{
		uint8_t handle;					//雷达控制句柄
		DeviceState device_state;		//雷达设备状态
		DeviceInfo info;				//雷达基本信息
	} DeviceItem;
==public:==
	CLivoxLaser() = delete;
	CLivoxLaser(const CLivoxLaser& other) = delete;
	//唯一的构造函数，按照设备名称和雷达参数来创建实例。
	CLivoxLaser(int id, Laser_proto::laser_parameter laser_param);
	~CLivoxLaser();
..
	//雷达链接设备，为3个线程添加线程执行函数。
	virtual Error_manager connect_laser();
	//雷达断开链接，释放3个线程
	virtual Error_manager disconnect_laser();
	//对外的接口函数，负责接受并处理任务单，
	virtual Error_manager execute_task(Task_Base* p_laser_task);
	//检查雷达状态,是否正常运行
	virtual Error_manager check_laser();
	//雷达的启动接口函数， 让雷达进行扫描，一般需要子类重载，不同的雷达开始方式不同。
	virtual Error_manager start_scan();
	//雷达的停止接口函数， 让雷达停止扫描，一般需要子类重载，不同的雷达结束方式不同。
	virtual Error_manager stop_scan();
	//结束任务单，stop之后，要检查线程状态和数据结果，然后才能 end_task
	virtual Error_manager end_task();
..
	//判断雷达状态是否为待机，如果已经准备好，则可以执行任务。
	//子类重载 is_ready()，里面增加livox sdk后台线程状态的判断。
	virtual bool is_ready();
==protected:==
	//接受二进制消息的功能函数，每次只接受一个CBinaryData
	virtual bool receive_buf_to_queue(Binary_buf& binary_buf);
	//将二进制消息转化为三维点云的功能函数，每次只转化一个CBinaryData，
	virtual Buf_type transform_buf_to_points(Binary_buf* p_binary_buf, std::vector<CPoint3D>& point3D_cloud);
==protected:==
	static void InitLivox();
	virtual bool IsScanComplete();
	virtual void UpdataHandle();
	static void LidarDataCallback(uint8_t handle, LivoxEthPacket *data, uint32_t data_num, void *laser);
	static void OnDeviceChange(const DeviceInfo *info, DeviceEvent type);
	static void OnDeviceBroadcast(const BroadcastDeviceInfo *info);
	static void OnSampleCallback(uint8_t status, uint8_t handle, uint8_t response, void *data);
==protected:==
	uint8_t									m_handle;
	unsigned int							m_frame_maxnum;
	Thread_safe_queue<Binary_buf*>			m_queue_livox_data;
	static DeviceItem						g_devices[kMaxLidarCount];
	static std::map<uint8_t,std::string>	g_handle_sn;
	static std::map<std::string, uint8_t>	g_sn_handle;
	static std::map<std::string, CLivoxLaser*> g_sn_laser;
	static CLivoxLaser*						g_all_laser[kMaxLidarCount];
	static unsigned int						g_count[kMaxLidarCount];
}


class Laser_base
{
//雷达的基类，不能直接使用，必须子类继承
==public:==
	Laser_base() = delete;
	Laser_base(const Laser_base& other) = delete;
..
	//唯一的构造函数，按照设备名称和雷达参数来创建实例。
	//input：id： 雷达设备的id，（唯一索引）
	//input：laser_param：雷达的参数，
	//注：利用protobuf创建 laser_parameter 类，然后从文件读取参数
	Laser_base(int laser_id,Laser_proto::laser_parameter laser_param);
	//析构函数
	~Laser_base();
..
	//雷达链接设备，为3个线程添加线程执行函数。
	virtual Error_manager connect_laser();
	//雷达断开链接，释放3个线程
	virtual Error_manager disconnect_laser();
	//对外的接口函数，负责接受并处理任务单，
	//input：p_laser_task 雷达任务单，基类的指针，指向子类的实例，（多态）
	//注：这个函数为虚函数，实际的处理任务的代码由子类重载并实现。
	virtual Error_manager execute_task(Task_Base* p_laser_task);
	//检查雷达状态,是否正常运行
	virtual Error_manager check_laser();
	//雷达的启动接口函数， 让雷达进行扫描，一般需要子类重载，不同的雷达开始方式不同。
	virtual Error_manager start_scan();
	//雷达的停止接口函数， 让雷达停止扫描，一般需要子类重载，不同的雷达结束方式不同。
	virtual Error_manager stop_scan();
	//结束任务单，stop之后，要检查线程状态和数据结果，然后才能 end_task
	virtual Error_manager end_task();
==public:==
	//设置保存文件的路径，并打开文件，
	Error_manager set_open_save_path(std::string save_path,bool is_save=true);
	//关闭保存文件，推出前一定要执行
	Error_manager close_save_path();
	//判断雷达状态是否为待机，如果已经准备好，则可以执行任务。
	//子类重载 is_ready()，里面增加livox sdk后台线程状态的判断。
	virtual bool is_ready();
	//获取雷达id
	int get_laser_id();
==protected:==
	//接受二进制消息的功能函数，每次只接受一个CBinaryData
	// 纯虚函数，必须由子类重载，
	virtual bool receive_buf_to_queue(Binary_buf& binary_buf) = 0;
	//线程执行函数，将二进制消息存入队列缓存，
	void thread_receive();
..
	//将二进制消息转化为三维点云的功能函数，每次只转化一个CBinaryData，
	// 纯虚函数，必须由子类重载，
	virtual Buf_type transform_buf_to_points(Binary_buf* p_binary_buf, std::vector<CPoint3D>& point3D_cloud)=0;
	//线程执行函数，转化并处理三维点云。
	void thread_transform();
..
	//公开发布雷达信息的功能函数，
	Error_manager publish_laser_to_message();
	//线程执行函数，公开发布雷达的相关信息，用作上位机的监视。
	static void thread_publish(Laser_base* p_laser);
..
	//获取雷达状态
	Laser_statu get_laser_statu();
==protected:==
	//初始化变换矩阵，设置默认值
	Error_manager init_laser_matrix();
	//设置变换矩阵，用作三维点的坐标变换，
	Error_manager set_laser_matrix(double* p_matrix, int size);
..
	//三维点的坐标变换的功能函数，从雷达自己的坐标系，转化到公共坐标系，（目前以plc为公共坐标系）
	virtual CPoint3D transform_by_matrix(CPoint3D point);
==protected:==
	//为了保证多线程的数据安全，修改共享数据必须加锁。  atomic 和 安全队列 可以不加锁进行读写
	//建议：判断标志位使用 atomic， 容器要封装并使用 安全容器，
	std::mutex          				m_laser_lock;            	//雷达数据锁
..
	std::atomic<int>					m_laser_id;                 //雷达设备id
	Laser_proto::laser_parameter  		m_laser_param;				//雷达的配置参数
	//雷达变换矩阵，三维点的坐标变换的矩阵，从雷达自己的坐标系，转化到公共坐标系，（目前以plc为公共坐标系）
	//必须在set_laser_matrix之后，才能使用。（connect时，从雷达的配置参数导入）
	double								mp_laser_matrix[LASER_MATRIX_ARRAY_SIZE];	//雷达变换矩阵
	//雷达扫描事件的标志位，受start和stop控制，然后其他线程判断m_scan_flag标准位，来进行启停。
	std::atomic<bool>                	m_laser_scan_flag;          //雷达扫描的使能标志位
	//雷达状态和任务状态同步，m_scan_flag停止之后，还要等任务执行完成,才会切回 ready。
	std::atomic<Laser_statu>			m_laser_statu;             	//雷达工作状态，基类三线程的状态
	//注：m_laser_statu是基类的三线程的状态，和livox sdk后台线程状态没有任何关系。
	//子类重载 is_ready()，里面增加livox sdk后台线程状态的判断。
..
	std::atomic<int>            		m_points_count;         	//雷达采集点的计数
	Thread_safe_queue<Binary_buf*>		m_queue_laser_data;         //二进制缓存的队列容器
	Binary_buf							m_last_data;			    //上一个二进制缓存，用作数据拼接
..
	std::atomic<bool> 					m_save_flag;           		//雷达保存文件的使能标志位
	std::string							m_save_path;            	//雷达保存文件的保存路径
	CLogFile							m_binary_log_tool;          //二进制缓存的日志工具
	CLogFile							m_points_log_tool;          //三维点云的日志工具
..
	//线程指针的内存管理，由Connect和Disconnect进行分配和释放。
	std::thread*						mp_thread_receive;    		//接受缓存的线程指针
	Thread_condition					m_condition_receive;		//接受缓存的条件变量
	std::thread*						mp_thread_transform;   		//转化数据的线程指针
	Thread_condition					m_condition_transform;		//转化数据的条件变量
	std::thread*        				mp_thread_publish;   		//发布信息的线程指针
	Thread_condition					m_condition_publish;		//发布信息的条件变量
..
	//任务单的指针，实际内存由应用层管理，
	//接受任务后，指向新的任务单
	Laser_task *  						mp_laser_task;        		//任务单的指针
}

class CLivoxMid100Laser
{
==public:==
	CLivoxMid100Laser(int id, Laser_proto::laser_parameter laser_param);
	~CLivoxMid100Laser();
..
	//雷达链接设备，为3个线程添加线程执行函数。
	virtual Error_manager connect_laser();
	//雷达断开链接，释放3个线程
	virtual Error_manager disconnect_laser();
	//对外的接口函数，负责接受并处理任务单，
	//input：p_laser_task 雷达任务单，基类的指针，指向子类的实例，（多态）
	//注：这个函数为虚函数，实际的处理任务的代码由子类重载并实现。
	virtual Error_manager execute_task(Task_Base* p_laser_task);
	//检查雷达状态,是否正常运行
	virtual Error_manager check_laser();
	//雷达的启动接口函数， 让雷达进行扫描，一般需要子类重载，不同的雷达开始方式不同。
	virtual Error_manager start_scan();
	//雷达的停止接口函数， 让雷达停止扫描，一般需要子类重载，不同的雷达结束方式不同。
	virtual Error_manager stop_scan();
	//结束任务单，stop之后，要检查线程状态和数据结果，然后才能 end_task
	virtual Error_manager end_task();
..
	//判断雷达状态是否为待机，如果已经准备好，则可以执行任务。
	//子类重载 is_ready()，里面增加livox sdk后台线程状态的判断。
	virtual bool is_ready();
==protected:==
	virtual bool IsScanComplete();
	virtual void UpdataHandle();
==protected:==
	uint8_t		m_handle1;
	uint8_t		m_handle2;
	uint8_t		m_handle3;
}

Laser_base -> CLivoxLaser : inherit
CLivoxLaser -> CLivoxMid100Laser : inherit


@enduml