USRP Hardware Driver and USRP Manual  Version: 003.010.002.HEAD-0-gbd6e21dc
UHD and USRP Manual
uhd::usrp::dboard_manager Class Referenceabstract

#include <uhd/usrp/dboard_manager.hpp>

Inheritance diagram for uhd::usrp::dboard_manager:

Public Types

typedef boost::shared_ptr< dboard_managersptr
 
typedef dboard_base::sptr(* dboard_ctor_t) (dboard_base::ctor_args_t)
 

Public Member Functions

virtual ~dboard_manager ()
 
virtual void initialize_dboards ()=0
 
virtual const std::vector< std::string > & get_rx_frontends () const =0
 
virtual const std::vector< std::string > & get_tx_frontends () const =0
 

Static Public Member Functions

static void register_dboard (const dboard_id_t &dboard_id, dboard_ctor_t db_subdev_ctor, const std::string &name, const std::vector< std::string > &subdev_names=std::vector< std::string >(1, "0"), dboard_ctor_t db_container_ctor=NULL)
 
static void register_dboard (const dboard_id_t &rx_dboard_id, const dboard_id_t &tx_dboard_id, dboard_ctor_t db_subdev_ctor, const std::string &name, const std::vector< std::string > &subdev_names=std::vector< std::string >(1, "0"), dboard_ctor_t db_container_ctor=NULL)
 
static void register_dboard_restricted (const dboard_id_t &dboard_id, dboard_ctor_t db_subdev_ctor, const std::string &name, const std::vector< std::string > &subdev_names=std::vector< std::string >(1, "0"), dboard_ctor_t db_container_ctor=NULL)
 
static void register_dboard_restricted (const dboard_id_t &rx_dboard_id, const dboard_id_t &tx_dboard_id, dboard_ctor_t db_subdev_ctor, const std::string &name, const std::vector< std::string > &subdev_names=std::vector< std::string >(1, "0"), dboard_ctor_t db_container_ctor=NULL)
 
static sptr make (dboard_id_t rx_dboard_id, dboard_id_t tx_dboard_id, dboard_id_t gdboard_id, dboard_iface::sptr iface, property_tree::sptr subtree, bool defer_db_init=false)
 

Detailed Description

A daughter board subdev dboard_manager class. Create subdev instances for each subdev on a dboard. Provide wax::obj access to the subdevs inside.

Member Typedef Documentation

◆ dboard_ctor_t

typedef dboard_base::sptr(* uhd::usrp::dboard_manager::dboard_ctor_t) (dboard_base::ctor_args_t)

◆ sptr

typedef boost::shared_ptr<dboard_manager> uhd::usrp::dboard_manager::sptr

Constructor & Destructor Documentation

◆ ~dboard_manager()

virtual uhd::usrp::dboard_manager::~dboard_manager ( )
inlinevirtual

Member Function Documentation

◆ get_rx_frontends()

virtual const std::vector<std::string>& uhd::usrp::dboard_manager::get_rx_frontends ( ) const
pure virtual

Returns a vector of RX frontend (subdev) names

Returns
a vector of names

◆ get_tx_frontends()

virtual const std::vector<std::string>& uhd::usrp::dboard_manager::get_tx_frontends ( ) const
pure virtual

Returns a vector of TX frontend (subdev) names

Returns
a vector of names

◆ initialize_dboards()

virtual void uhd::usrp::dboard_manager::initialize_dboards ( )
pure virtual

Run dboard post constructor initializations if defered during make

◆ make()

static sptr uhd::usrp::dboard_manager::make ( dboard_id_t  rx_dboard_id,
dboard_id_t  tx_dboard_id,
dboard_id_t  gdboard_id,
dboard_iface::sptr  iface,
property_tree::sptr  subtree,
bool  defer_db_init = false 
)
static

Make a new dboard manager.

Parameters
rx_dboard_idthe id of the rx dboard
tx_dboard_idthe id of the tx dboard
gdboard_idthe id of the grand-dboard
ifacethe custom dboard interface
subtreethe subtree to load with props
defer_db_initinitialising the daughterboards (DEPRECATED)
Returns
an sptr to the new dboard manager

◆ register_dboard() [1/2]

static void uhd::usrp::dboard_manager::register_dboard ( const dboard_id_t dboard_id,
dboard_ctor_t  db_subdev_ctor,
const std::string &  name,
const std::vector< std::string > &  subdev_names = std::vector< std::string >(1, "0"),
dboard_ctor_t  db_container_ctor = NULL 
)
static

Register a rx or tx dboard into the system. For single subdevice boards, omit subdev_names.

Parameters
dboard_idthe dboard id (rx or tx)
db_subdev_ctorthe dboard sub-device constructor function pointer (one instance per subdev name)
namethe canonical name for the dboard represented
subdev_namesthe names of the subdevs on this dboard
db_container_ctorthe dboard container constructor function pointer (one instance per dboard)

◆ register_dboard() [2/2]

static void uhd::usrp::dboard_manager::register_dboard ( const dboard_id_t rx_dboard_id,
const dboard_id_t tx_dboard_id,
dboard_ctor_t  db_subdev_ctor,
const std::string &  name,
const std::vector< std::string > &  subdev_names = std::vector< std::string >(1, "0"),
dboard_ctor_t  db_container_ctor = NULL 
)
static

Register an xcvr dboard into the system. For single subdevice boards, omit subdev_names.

Parameters
rx_dboard_idthe rx unit dboard id
tx_dboard_idthe tx unit dboard id
db_subdev_ctorthe dboard sub-device constructor function pointer (one instance per subdev name)
namethe canonical name for the dboard represented
subdev_namesthe names of the subdevs on this dboard
db_container_ctorthe dboard container constructor function pointer (one instance per dboard)

◆ register_dboard_restricted() [1/2]

static void uhd::usrp::dboard_manager::register_dboard_restricted ( const dboard_id_t dboard_id,
dboard_ctor_t  db_subdev_ctor,
const std::string &  name,
const std::vector< std::string > &  subdev_names = std::vector< std::string >(1, "0"),
dboard_ctor_t  db_container_ctor = NULL 
)
static

Register a restricted rx or tx dboard into the system. A restricted dboard does not add its dboard_iface object into the property tree. For single subdevice boards, omit subdev_names. The iface for a restricted board is not registered into the property tree.

Parameters
dboard_idthe dboard id (rx or tx)
db_subdev_ctorthe dboard sub-device constructor function pointer (one instance per subdev name)
namethe canonical name for the dboard represented
subdev_namesthe names of the subdevs on this dboard
db_container_ctorthe dboard container constructor function pointer (one instance per dboard)

◆ register_dboard_restricted() [2/2]

static void uhd::usrp::dboard_manager::register_dboard_restricted ( const dboard_id_t rx_dboard_id,
const dboard_id_t tx_dboard_id,
dboard_ctor_t  db_subdev_ctor,
const std::string &  name,
const std::vector< std::string > &  subdev_names = std::vector< std::string >(1, "0"),
dboard_ctor_t  db_container_ctor = NULL 
)
static

Register a restricted xcvr dboard into the system. A restricted dboard does not add its dboard_iface object into the property tree. For single subdevice boards, omit subdev_names. The iface for a restricted board is not registered into the property tree.

Parameters
rx_dboard_idthe rx unit dboard id
tx_dboard_idthe tx unit dboard id
db_subdev_ctorthe dboard sub-device constructor function pointer (one instance per subdev name)
namethe canonical name for the dboard represented
subdev_namesthe names of the subdevs on this dboard
db_container_ctorthe dboard container constructor function pointer (one instance per dboard)

The documentation for this class was generated from the following file: