UHD  003.004.002-23-stable
include/uhd/usrp/dboard_id.hpp
Go to the documentation of this file.
00001 //
00002 // Copyright 2010 Ettus Research LLC
00003 //
00004 // This program is free software: you can redistribute it and/or modify
00005 // it under the terms of the GNU General Public License as published by
00006 // the Free Software Foundation, either version 3 of the License, or
00007 // (at your option) any later version.
00008 //
00009 // This program is distributed in the hope that it will be useful,
00010 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00011 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00012 // GNU General Public License for more details.
00013 //
00014 // You should have received a copy of the GNU General Public License
00015 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
00016 //
00017 
00018 #ifndef INCLUDED_UHD_USRP_DBOARD_ID_HPP
00019 #define INCLUDED_UHD_USRP_DBOARD_ID_HPP
00020 
00021 #include <uhd/config.hpp>
00022 #include <boost/cstdint.hpp>
00023 #include <boost/operators.hpp>
00024 #include <string>
00025 
00026 namespace uhd{ namespace usrp{
00027 
00028     class UHD_API dboard_id_t : boost::equality_comparable<dboard_id_t>{
00029     public:
00034         dboard_id_t(boost::uint16_t id = 0xffff);
00035 
00040         static dboard_id_t none(void);
00041 
00047         static dboard_id_t from_uint16(boost::uint16_t uint16);
00048 
00053         boost::uint16_t to_uint16(void) const;
00054 
00061         static dboard_id_t from_string(const std::string &string);
00062 
00067         std::string to_string(void) const;
00068 
00073         std::string to_cname(void) const;
00074 
00079         std::string to_pp_string(void) const;
00080 
00081     private:
00082         boost::uint16_t _id; //internal representation
00083     };
00084 
00092     UHD_API bool operator==(const dboard_id_t &lhs, const dboard_id_t &rhs);
00093 
00094 }} //namespace
00095 
00096 #endif /* INCLUDED_UHD_USRP_DBOARD_ID_HPP */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines