bitrl::sensors::backends::RangeSensorBackendBase Class Reference

Base class for modelling range sensors. More...

#include <range_sensor_backend_base.h>

Inheritance diagram for bitrl::sensors::backends::RangeSensorBackendBase:

Collaboration diagram for bitrl::sensors::backends::RangeSensorBackendBase:

Public Member Functions
real_t	max_distance () const noexcept
void	set_max_distance (real_t max_distance) noexcept
	Set the maximum distance the range sensor can read.
real_t	min_distance () const noexcept
void	set_min_distance (real_t min_distance) noexcept
	Set the maximum distance the range sensor can read.
virtual std::string	sensor_units () const
void	set_sensor_units (const std::string &units)
	Set the sensor units.
Public Member Functions inherited from bitrl::sensors::backends::SensorBackendBase
virtual	~SensorBackendBase ()=default
	Destructor.
real_t	sampling_period () const noexcept
	Returns the sampling period of the sensor.
void	set_sampling_period (real_t period)
	Set the sampling period of the backend.
virtual std::vector< real_t >	read_values ()=0
	Read the sensor value.
virtual void	load_from_json (const std::string &filename)=0
	Load robot and simulation parameters from a JSON file.
uint_t	n_read_values () const noexcept
std::string	backend_type_str () const noexcept

Protected Member Functions
	RangeSensorBackendBase (const std::string &backend_type)
	Constructor.
Protected Member Functions inherited from bitrl::sensors::backends::SensorBackendBase
	SensorBackendBase (const std::string &backend_type)
	Constructor.

Detailed Description

Base class for modelling range sensors.

Constructor & Destructor Documentation

RangeSensorBackendBase()

bitrl::sensors::backends::RangeSensorBackendBase::RangeSensorBackendBase ( const std::string &  backend_type )

inlineexplicitprotected

Constructor.

Parameters

backend_type

Member Function Documentation

max_distance()

real_t bitrl::sensors::backends::RangeSensorBackendBase::max_distance ( ) const

inlinenoexcept

Returns

The maximum distance the range sensor can read

min_distance()

real_t bitrl::sensors::backends::RangeSensorBackendBase::min_distance ( ) const

inlinenoexcept

Returns

The maximum distance the range sensor can read

sensor_units()

virtual std::string bitrl::sensors::backends::RangeSensorBackendBase::sensor_units ( ) const

inlinevirtual

Returns

An instance of std::string representing the units the sensor readings are assumed in

Reimplemented from bitrl::sensors::backends::SensorBackendBase.

set_max_distance()

void bitrl::sensors::backends::RangeSensorBackendBase::set_max_distance ( real_t  max_distance )

inlinenoexcept

Set the maximum distance the range sensor can read.

Parameters

max_distance

set_min_distance()

void bitrl::sensors::backends::RangeSensorBackendBase::set_min_distance ( real_t  min_distance )

inlinenoexcept

Set the maximum distance the range sensor can read.

Parameters

min_distance

set_sensor_units()

void bitrl::sensors::backends::RangeSensorBackendBase::set_sensor_units ( const std::string &  units )

inline

Set the sensor units.

Parameters

units

The string representing the sensor units

---

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

• libs/bitrl/src/bitrl/sensors/backends/range_sensor_backend_base.h