dboard_id.hpp

Go to the documentation of this file.

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

#ifndef INCLUDED_UHD_USRP_DBOARD_ID_HPP
#define INCLUDED_UHD_USRP_DBOARD_ID_HPP

#include <uhd/config.hpp>
#include <stdint.h>
#include <boost/operators.hpp>
#include <string>

namespace uhd { namespace usrp {

class UHD_API dboard_id_t : boost::equality_comparable<dboard_id_t>
{
public:
    dboard_id_t(uint16_t id = 0xffff);

    static dboard_id_t none(void);

    static dboard_id_t from_uint16(uint16_t uint16);

    uint16_t to_uint16(void) const;

    static dboard_id_t from_string(const std::string& string);

    std::string to_string(void) const;

    std::string to_cname(void) const;

    std::string to_pp_string(void) const;

private:
    uint16_t _id; // internal representation
};

UHD_API bool operator==(const dboard_id_t& lhs, const dboard_id_t& rhs);

}} // namespace uhd::usrp

#endif /* INCLUDED_UHD_USRP_DBOARD_ID_HPP */