UHD 003.002.000

include/uhd/usrp/dboard_base.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_BASE_HPP
00019 #define INCLUDED_UHD_USRP_DBOARD_BASE_HPP
00020 
00021 #include <uhd/config.hpp>
00022 #include <uhd/wax.hpp>
00023 #include <uhd/utils/pimpl.hpp>
00024 #include <boost/utility.hpp>
00025 #include <boost/shared_ptr.hpp>
00026 #include <uhd/usrp/dboard_id.hpp>
00027 #include <uhd/usrp/dboard_iface.hpp>
00028 
00029 namespace uhd{ namespace usrp{
00030 
00040     enum subdev_conn_t{
00041         SUBDEV_CONN_COMPLEX_IQ = 'C',
00042         SUBDEV_CONN_COMPLEX_QI = 'c',
00043         SUBDEV_CONN_REAL_I     = 'R',
00044         SUBDEV_CONN_REAL_Q     = 'r'
00045     };
00046 
00050     enum subdev_prop_t{
00051         SUBDEV_PROP_NAME,               //ro, std::string
00052         SUBDEV_PROP_OTHERS,             //ro, prop_names_t
00053         SUBDEV_PROP_SENSOR,             //ro, sensor_value_t
00054         SUBDEV_PROP_SENSOR_NAMES,       //ro, prop_names_t
00055         SUBDEV_PROP_GAIN,               //rw, double
00056         SUBDEV_PROP_GAIN_RANGE,         //ro, gain_range_t
00057         SUBDEV_PROP_GAIN_NAMES,         //ro, prop_names_t
00058         SUBDEV_PROP_FREQ,               //rw, double
00059         SUBDEV_PROP_FREQ_RANGE,         //ro, freq_range_t
00060         SUBDEV_PROP_ANTENNA,            //rw, std::string
00061         SUBDEV_PROP_ANTENNA_NAMES,      //ro, prop_names_t
00062         SUBDEV_PROP_CONNECTION,         //ro, subdev_conn_t
00063         SUBDEV_PROP_ENABLED,            //rw, bool
00064         SUBDEV_PROP_USE_LO_OFFSET,      //ro, bool
00065         SUBDEV_PROP_BANDWIDTH           //rw, double
00066     };
00067 
00072 class UHD_API dboard_base : boost::noncopyable{
00073 public:
00074     typedef boost::shared_ptr<dboard_base> sptr;
00080     typedef void * ctor_args_t;
00081 
00082     //structors
00083     dboard_base(ctor_args_t);
00084     virtual ~dboard_base(void);
00085 
00086     //interface
00087     virtual void rx_get(const wax::obj &key, wax::obj &val) = 0;
00088     virtual void rx_set(const wax::obj &key, const wax::obj &val) = 0;
00089     virtual void tx_get(const wax::obj &key, wax::obj &val) = 0;
00090     virtual void tx_set(const wax::obj &key, const wax::obj &val) = 0;
00091 
00092 protected:
00093     std::string get_subdev_name(void);
00094     dboard_iface::sptr get_iface(void);
00095     dboard_id_t get_rx_id(void);
00096     dboard_id_t get_tx_id(void);
00097 
00098 private:
00099     UHD_PIMPL_DECL(impl) _impl;
00100 };
00101 
00106 class UHD_API xcvr_dboard_base : public dboard_base{
00107 public:
00111     xcvr_dboard_base(ctor_args_t);
00112 
00113     virtual ~xcvr_dboard_base(void);
00114 };
00115 
00120 class UHD_API rx_dboard_base : public dboard_base{
00121 public:
00125     rx_dboard_base(ctor_args_t);
00126 
00127     virtual ~rx_dboard_base(void);
00128 
00129     //override here so the derived classes cannot
00130     void tx_get(const wax::obj &key, wax::obj &val);
00131     void tx_set(const wax::obj &key, const wax::obj &val);
00132 };
00133 
00138 class UHD_API tx_dboard_base : public dboard_base{
00139 public:
00143     tx_dboard_base(ctor_args_t);
00144 
00145     virtual ~tx_dboard_base(void);
00146 
00147     //override here so the derived classes cannot
00148     void rx_get(const wax::obj &key, wax::obj &val);
00149     void rx_set(const wax::obj &key, const wax::obj &val);
00150 };
00151 
00152 }} //namespace
00153 
00154 #endif /* INCLUDED_UHD_USRP_DBOARD_BASE_HPP */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines