sensors.hpp

Go to the documentation of this file.

//
// Copyright 2011 Ettus Research LLC
// Copyright 2018 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//

#ifndef INCLUDED_UHD_TYPES_SENSORS_HPP
#define INCLUDED_UHD_TYPES_SENSORS_HPP

#include <uhd/config.hpp>
#include <map>
#include <string>

namespace uhd {

struct UHD_API sensor_value_t
{
    typedef std::map<std::string, std::string> sensor_map_t;

    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);

    sensor_value_t(const std::map<std::string, std::string>& sensor_dict);

    sensor_value_t(const sensor_value_t& source);

    bool to_bool(void) const;

    signed to_int(void) const;

    double to_real(void) const;

    sensor_map_t to_map(void) const;

    std::string name;

    std::string value;

    std::string unit;

    enum data_type_t { BOOLEAN = 'b', INTEGER = 'i', REALNUM = 'r', STRING = 's' };

    data_type_t type;

    std::string to_pp_string(void) const;

    sensor_value_t& operator=(const sensor_value_t& value);
};

} // namespace uhd

#endif /* INCLUDED_UHD_TYPES_SENSORS_HPP */