upkie::cpp::sensors::SensorPipeline Class Reference

Sensor pipeline. More...

#include <SensorPipeline.h>

Public Member Functions
void	connect_sensor (std::shared_ptr< Sensor > sensor)
	Add a sensor at the beginning of the pipeline. More...
void	run (Dictionary &observation)
	Run observer pipeline on an observation dictionary. More...

Detailed Description

Sensor pipeline.

A sensor pipeline is a list of sensors, to be executed in that order.

Member Function Documentation

connect_sensor()

void upkie::cpp::sensors::SensorPipeline::connect_sensor ( std::shared_ptr< Sensor >  sensor )

inline

Add a sensor at the beginning of the pipeline.

Parameters

[in]

sensor

Sensor to append.

Note

Contrary to observers, the order in which sensors are executed is not guaranteed. If a sensor needs to run after another, consider splitting it into one sensor and one observer.

run()

void upkie::cpp::sensors::SensorPipeline::run

(

Dictionary &

observation

)

Run observer pipeline on an observation dictionary.

Parameters

[in,out]

observation

Observation dictionary.

---

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

• upkie/cpp/sensors/SensorPipeline.h
• upkie/cpp/sensors/SensorPipeline.cpp