pwr_cal.hpp

Go to the documentation of this file.

//
// Copyright 2020 Ettus Research, a National Instruments Brand
//
// SPDX-License-Identifier: GPL-3.0-or-later
//
 
#pragma once
 
#include <uhd/cal/container.hpp>
#include <uhd/config.hpp>
#include <uhd/types/ranges.hpp>
#include <boost/none.hpp>
#include <boost/optional.hpp>
#include <cstdint>
#include <map>
#include <memory>
#include <optional>
#include <string>
 
namespace uhd { namespace usrp { namespace cal {

class UHD_API pwr_cal : public container
{
public:
    using sptr = std::shared_ptr<pwr_cal>;

    virtual void add_power_table(const std::map<double, double>& gain_power_map,
        const double min_power,
        const double max_power,
        const double freq,
        const std::optional<int> temperature = {}) = 0;
 
    // Helper to resolve between the two optional methods
    void add_power_table(const std::map<double, double>& gain_power_map,
        const double min_power,
        const double max_power,
        const double freq,
        const int temperature)
    {
        add_power_table(gain_power_map,
            min_power,
            max_power,
            freq,
            std::make_optional<int>(temperature));
    }
 
    [[deprecated("Prefer std::optional over boost::optional.")]] void add_power_table(
        const std::map<double, double>& gain_power_map,
        const double min_power,
        const double max_power,
        const double freq,
        const boost::optional<int> temperature)
    {
        add_power_table(gain_power_map,
            min_power,
            max_power,
            freq,
            bool(temperature) ? std::make_optional<int>(*temperature) : std::nullopt);
    }
 

    virtual void clear() = 0;

    virtual void set_temperature(const int temperature) = 0;

    virtual int get_temperature() const = 0;

    virtual void set_ref_gain(const double gain) = 0;

    virtual double get_ref_gain() const = 0;

    virtual uhd::meta_range_t get_power_limits(
        const double freq, const std::optional<int> temperature = {}) const = 0;
 
    // Helper to resolve between the two optional methods
    uhd::meta_range_t get_power_limits(const double freq, const int temperature) const
    {
        return get_power_limits(freq, std::make_optional<int>(temperature));
    }
 
    [[deprecated("Prefer std::optional over boost::optional.")]] uhd::meta_range_t
    get_power_limits(const double freq, const boost::optional<int> temperature) const
    {
        return get_power_limits(freq,
            bool(temperature) ? std::make_optional<int>(*temperature) : std::nullopt);
    }

    virtual double get_power(const double gain,
        const double freq,
        const std::optional<int> temperature = {}) const = 0;
 
    double get_power(const double gain, const double freq, const int temperature) const
    {
        return get_power(gain, freq, std::make_optional<int>(temperature));
    }
 
    [[deprecated("Prefer std::optional over boost::optional.")]] double get_power(
        const double gain,
        const double freq,
        const boost::optional<int> temperature) const
    {
        return get_power(gain,
            freq,
            bool(temperature) ? std::make_optional<int>(*temperature) : std::nullopt);
    }

    virtual double get_gain(const double power_dbm,
        const double freq,
        const std::optional<int> temperature = {}) const = 0;
 
    double get_gain(
        const double power_dbm, const double freq, const int temperature) const
    {
        return get_gain(power_dbm, freq, std::make_optional<int>(temperature));
    }
 
    [[deprecated("Prefer std::optional over boost::optional.")]] double get_gain(
        const double power_dbm,
        const double freq,
        const boost::optional<int> temperature) const
    {
        return get_gain(power_dbm,
            freq,
            bool(temperature) ? std::make_optional<int>(*temperature) : std::nullopt);
    }

    static sptr make(
        const std::string& name, const std::string& serial, const uint64_t timestamp);

    static sptr make();
};
 
}}} // namespace uhd::usrp::cal