Witmotion IMU Library  1.3.1~dev_4684448
Open source UART communication library for sensor devices manufactured by WitMotion Shenzhen Co.,Ltd
Public Slots | Signals | Protected Slots | List of all members
witmotion::QAbstractWitmotionSensorReader Class Referenceabstract

Abstract base class to program convenience classes for the sensors. More...

#include <types.h>

Inheritance diagram for witmotion::QAbstractWitmotionSensorReader:
Inheritance graph
Collaboration diagram for witmotion::QAbstractWitmotionSensorReader:
Collaboration graph

Public Slots

virtual void SendConfig (const witmotion_config_packet &packet)=0
 Public abstract slot to be implemented in the derived class. More...
 
virtual void RunPoll ()=0
 Public abstract slot to be implemented in the derived class. The common use is to start the polling timer thread for the sensors after Qt event loop is started.
 

Signals

void Acquired (const witmotion_datapacket &packet)
 Signal function to be emitted when the data packet is acquired by the polling thread or process. Can only be redefined, not overridden in the class hierarchy.
 
void Error (const QString &description)
 Signal function to be emitted when the internal error reported in the polling thread or process. Can only be redefined, not overridden in the class hierarchy.
 

Protected Slots

virtual void ReadData ()=0
 Protected abstract slot to be implemented in the derived class. The common usage is as a callback for the polling timer thread.
 

Detailed Description

This class allows the developer to write handler functions for multithreaded polling timer control, sensor configuration request and data decoding event. It also provides predefined signals to allow the end user to react on actual data acquisition and error occurence events. The common use case for this class is to provide a base interface for the family of sensors supporting the same protocol. Please refer to QBaseSerialWitmotionSensorReader class for actual implementation of the currently supported UART-based protocol.

Member Function Documentation

◆ SendConfig

virtual void witmotion::QAbstractWitmotionSensorReader::SendConfig ( const witmotion_config_packet &  packet)
pure virtualslot
Parameters
packetaccepts the witmotion_config_packet object for being sent to the sensor configuration registers.

Implemented in witmotion::QBaseSerialWitmotionSensorReader.

The documentation for this class was generated from the following file: