uhd::sensor_value_t Struct Reference

#include <uhd/types/sensors.hpp>

Public Types
enum	data_type_t { BOOLEAN = 'b', INTEGER = 'i', REALNUM = 'r', STRING = 's' }
	Enumeration of possible data types in a sensor. More...

Public Member Functions
	sensor_value_t (const std::string &name, bool value, const std::string &utrue, const std::string &ufalse)
	sensor_value_t (const std::string &name, signed value, const std::string &unit, const std::string &formatter="%d")
	sensor_value_t (const std::string &name, double value, const std::string &unit, const std::string &formatter="%f")
	sensor_value_t (const std::string &name, const std::string &value, const std::string &unit)
bool	to_bool (void) const
	convert the sensor value to a boolean More...
signed	to_int (void) const
	convert the sensor value to an integer More...
double	to_real (void) const
	convert the sensor value to real number More...
std::string	to_pp_string (void) const
	Convert this sensor value into a printable string. More...

Public Attributes
const std::string	name
	The name of the sensor value. More...
const std::string	value
const std::string	unit
const data_type_t	type
	The data type of the value. More...

Detailed Description

A sensor value stores a sensor reading as a string with unit and data type. The sensor value class can be used in the following way:

sensor_value_t ref_lock_sensor("Reference", my_lock, "unlocked", "locked"); std::cout << ref_lock_sensor.to_pp_string() << std::endl; //prints Reference: locked

sensor_value_t temp_sensor("Temperature", my_temp, "C"); std::cout << temp_sensor.to_pp_string() << std::endl; //prints Temperature: 38.5 C

Member Enumeration Documentation

data_type_t

enum uhd::sensor_value_t::data_type_t

Enumeration of possible data types in a sensor.

Enumerator
BOOLEAN
INTEGER
REALNUM
STRING

Constructor & Destructor Documentation

sensor_value_t() [1/4]

uhd::sensor_value_t::sensor_value_t	(	const std::string &	name,
		bool	value,
		const std::string &	utrue,
		const std::string &	ufalse
	)

Create a sensor value from a boolean.

Parameters

name	the name of the sensor
value	the value true or false
utrue	the unit string when value is true
ufalse	the unit string when value is false

sensor_value_t() [2/4]

uhd::sensor_value_t::sensor_value_t	(	const std::string &	name,
		signed	value,
		const std::string &	unit,
		const std::string &	formatter = "%d"
	)

Create a sensor value from an integer.

Parameters

name	the name of the sensor
value	the signed integer value
unit	the associated unit type
formatter	the formatter string

sensor_value_t() [3/4]

uhd::sensor_value_t::sensor_value_t	(	const std::string &	name,
		double	value,
		const std::string &	unit,
		const std::string &	formatter = "%f"
	)

Create a sensor value from a real number.

Parameters

name	the name of the sensor
value	the real number value
unit	the associated unit type
formatter	the formatter string

sensor_value_t() [4/4]

uhd::sensor_value_t::sensor_value_t	(	const std::string &	name,
		const std::string &	value,
		const std::string &	unit
	)

Create a sensor value from a string.

Parameters

name	the name of the sensor
value	the real number value
unit	the associated unit type

Member Function Documentation

to_bool()

bool uhd::sensor_value_t::to_bool

(

void

)

const

convert the sensor value to a boolean

to_int()

signed uhd::sensor_value_t::to_int

(

void

)

const

convert the sensor value to an integer

to_pp_string()

std::string uhd::sensor_value_t::to_pp_string

(

void

)

const

Convert this sensor value into a printable string.

to_real()

double uhd::sensor_value_t::to_real

(

void

)

const

convert the sensor value to real number

Member Data Documentation

name

const std::string uhd::sensor_value_t::name

The name of the sensor value.

type

const data_type_t uhd::sensor_value_t::type

The data type of the value.

unit

const std::string uhd::sensor_value_t::unit

The sensor value's unit type. For boolean types, this will be the one of the two units depending upon the value of the boolean true or false.

value

const std::string uhd::sensor_value_t::value

The sensor value as a string. For integer and real number types, this will be the output of the formatter. For boolean types, the value will be the string literal "true" or "false".

---

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

• include/uhd/types/sensors.hpp