USRP Hardware Driver and USRP Manual: sensors.hpp Source File

| USRP Hardware Driver and USRP Manual Version: 4.8.0.makepkg-0-g308126a4 UHD and USRP Manual |

Loading...
Searching...
No Matches
sensors.hpp
Go to the documentation of this file.
1//
2// Copyright 2011 Ettus Research LLC
3// Copyright 2018 Ettus Research, a National Instruments Company
4//
5// SPDX-License-Identifier: GPL-3.0-or-later
6//
7
8#pragma once
9
10#include <uhd/config.hpp>
11#include <map>
12#include <string>
13
14namespace uhd {
15
28 struct UHD_API sensor_value_t
29{
30 typedef std::map<std::string, std::string> sensor_map_t;
31
39 sensor_value_t(const std::string& name,
40 bool value,
41 const std::string& utrue,
42 const std::string& ufalse);
43
51 sensor_value_t(const std::string& name,
52 signed value,
53 const std::string& unit,
54 const std::string& formatter = "%d");
55
63 sensor_value_t(const std::string& name,
64 double value,
65 const std::string& unit,
66 const std::string& formatter = "%f");
67
74 sensor_value_t(
75 const std::string& name, const std::string& value, const std::string& unit);
76
85 sensor_value_t(const std::map<std::string, std::string>& sensor_dict);
86
91 sensor_value_t(const sensor_value_t& source);
92
94 bool to_bool(void) const;
95
97 signed to_int(void) const;
98
100 double to_real(void) const;
101
103 sensor_map_t to_map(void) const;
104
106 std::string name;
107
113 std::string value;
114
120 std::string unit;
121
123 enum data_type_t { BOOLEAN = 'b', INTEGER = 'i', REALNUM = 'r', STRING = 's' };
124
126 data_type_t type;
127
129 std::string to_pp_string(void) const;
130
132 sensor_value_t& operator=(const sensor_value_t& value);
133};
134
135} // namespace uhd
UHD_API
#define UHD_API
Definition config.h:87
config.hpp
uhd
Definition build_info.hpp:12
uhd::sensor_value_t::to_bool
bool to_bool(void) const
convert the sensor value to a boolean
uhd::sensor_value_t::data_type_t
data_type_t
Enumeration of possible data types in a sensor.
Definition sensors.hpp:123
uhd::sensor_value_t::REALNUM
@ REALNUM
Definition sensors.hpp:123
uhd::sensor_value_t::INTEGER
@ INTEGER
Definition sensors.hpp:123
uhd::sensor_value_t::BOOLEAN
@ BOOLEAN
Definition sensors.hpp:123
uhd::sensor_value_t::STRING
@ STRING
Definition sensors.hpp:123
uhd::sensor_value_t::to_int
signed to_int(void) const
convert the sensor value to an integer
uhd::sensor_value_t::to_real
double to_real(void) const
convert the sensor value to real number
uhd::sensor_value_t::sensor_value_t
sensor_value_t(const std::string &name, signed value, const std::string &unit, const std::string &formatter="%d")
uhd::sensor_value_t::sensor_map_t
std::map< std::string, std::string > sensor_map_t
Definition sensors.hpp:30
uhd::sensor_value_t::sensor_value_t
sensor_value_t(const std::string &name, const std::string &value, const std::string &unit)
uhd::sensor_value_t::sensor_value_t
sensor_value_t(const std::string &name, bool value, const std::string &utrue, const std::string &ufalse)
uhd::sensor_value_t::value
std::string value
Definition sensors.hpp:113
uhd::sensor_value_t::sensor_value_t
sensor_value_t(const sensor_value_t &source)
uhd::sensor_value_t::to_map
sensor_map_t to_map(void) const
convert the sensor value to sensor_map_t
uhd::sensor_value_t::sensor_value_t
sensor_value_t(const std::string &name, double value, const std::string &unit, const std::string &formatter="%f")
uhd::sensor_value_t::operator=
sensor_value_t & operator=(const sensor_value_t &value)
Assignment operator for sensor value.
uhd::sensor_value_t::name
std::string name
The name of the sensor value.
Definition sensors.hpp:106
uhd::sensor_value_t::sensor_value_t
sensor_value_t(const std::map< std::string, std::string > &sensor_dict)
uhd::sensor_value_t::type
data_type_t type
The data type of the value.
Definition sensors.hpp:126
uhd::sensor_value_t::to_pp_string
std::string to_pp_string(void) const
Convert this sensor value into a printable string.
uhd::sensor_value_t::unit
std::string unit
Definition sensors.hpp:120