ekf_cal  0.4.0
A Kalman filter-based sensor calibration package
Sensor Class Reference

Pure base sensor class. More...

#include <sensor.hpp>

Inheritance diagram for Sensor:
[legend]

Classes

struct  Parameters
 Sensor parameter structure. More...
 

Public Types

typedef struct Sensor::Parameters Parameters
 Sensor parameter structure.
 

Public Member Functions

 Sensor (Parameters params)
 Sensor class constructor. More...
 
unsigned int GetId ()
 Sensor ID getter method. More...
 
std::string GetName ()
 Sensor name getter method. More...
 
void Callback (SensorMessage sensor_message)
 Sensor callback function. More...
 

Protected Attributes

double m_rate
 Sensor measurement rate.
 
unsigned int m_id
 Sensor id.
 
std::string m_name
 Sensor name.
 
std::shared_ptr< DebugLoggerm_logger
 Debug logger.
 
bool m_is_initialized {false}
 Sensor initialization flag.
 

Detailed Description

Pure base sensor class.

Todo:
Function for checking callback rate

Constructor & Destructor Documentation

◆ Sensor()

Sensor::Sensor ( Parameters  params)
explicit

Sensor class constructor.

Parameters
paramsSensor parameters

Member Function Documentation

◆ Callback()

void Sensor::Callback ( SensorMessage  sensor_message)

Sensor callback function.

Parameters
sensor_messagecallback message

◆ GetId()

unsigned int Sensor::GetId ( )

Sensor ID getter method.

Returns
Sensor ID

◆ GetName()

std::string Sensor::GetName ( )

Sensor name getter method.

Returns
Sensor name

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