uhd::device Class Reference

#include <uhd/device.hpp>

Inheritance diagram for uhd::device:

Public Types
enum	device_filter_t { ANY, USRP, CLOCK }
	Device type, used as a filter in make. More...
typedef boost::shared_ptr< device >	sptr
typedef boost::function< device_addrs_t(const device_addr_t &)>	find_t
typedef boost::function< sptr(const device_addr_t &)>	make_t

Public Member Functions
virtual	~device (void)=0
virtual rx_streamer::sptr	get_rx_stream (const stream_args_t &args)=0
	Make a new receive streamer from the streamer arguments. More...
virtual tx_streamer::sptr	get_tx_stream (const stream_args_t &args)=0
	Make a new transmit streamer from the streamer arguments. More...
uhd::property_tree::sptr	get_tree (void) const
	Get access to the underlying property structure. More...
device_filter_t	get_device_type () const
	Get device type. More...

Static Public Member Functions
static void	register_device (const find_t &find, const make_t &make, const device_filter_t filter)
static device_addrs_t	find (const device_addr_t &hint, device_filter_t filter=ANY)
	Find devices attached to the host. More...
static sptr	make (const device_addr_t &hint, device_filter_t filter=ANY, size_t which=0)
	Create a new device from the device address hint. More...

Protected Attributes
uhd::property_tree::sptr	_tree
device_filter_t	_type

Detailed Description

The device interface represents the hardware. The API allows for discovery, configuration, and streaming.

Member Typedef Documentation

find_t

typedef boost::function<device_addrs_t(const device_addr_t &)> uhd::device::find_t

make_t

typedef boost::function<sptr(const device_addr_t &)> uhd::device::make_t

sptr

typedef boost::shared_ptr<device> uhd::device::sptr

Member Enumeration Documentation

device_filter_t

enum uhd::device::device_filter_t

Device type, used as a filter in make.

Enumerator
ANY
USRP
CLOCK

Constructor & Destructor Documentation

~device()

virtual uhd::device::~device ( void  )

pure virtual

Member Function Documentation

find()

static device_addrs_t uhd::device::find ( const device_addr_t &  hint, device_filter_t  filter = ANY  )

static

Find devices attached to the host.

The hint device address should be used to narrow down the search to particular transport types and/or transport arguments.

Parameters

hint	a partially (or fully) filled in device address
filter	an optional filter to exclude USRP or clock devices

Returns

a vector of device addresses for all devices on the system

get_device_type()

device_filter_t uhd::device::get_device_type

(

)

const

Get device type.

get_rx_stream()

virtual rx_streamer::sptr uhd::device::get_rx_stream ( const stream_args_t &  args )

pure virtual

Make a new receive streamer from the streamer arguments.

Note: There can always only be one streamer. When calling get_rx_stream() a second time, the first streamer must be destroyed beforehand.

get_tree()

uhd::property_tree::sptr uhd::device::get_tree

(

void

)

const

Get access to the underlying property structure.

get_tx_stream()

virtual tx_streamer::sptr uhd::device::get_tx_stream ( const stream_args_t &  args )

pure virtual

Make a new transmit streamer from the streamer arguments.

Note: There can always only be one streamer. When calling get_tx_stream() a second time, the first streamer must be destroyed beforehand.

make()

static sptr uhd::device::make ( const device_addr_t &  hint, device_filter_t  filter = ANY, size_t  which = 0  )

static

Create a new device from the device address hint.

The make routine will call find and pick one of the results. By default, the first result will be used to create a new device. Use the which parameter as an index into the list of results.

Parameters

hint	a partially (or fully) filled in device address
filter	an optional filter to exclude USRP or clock devices
which	which address to use when multiple are found

Returns

a shared pointer to a new device instance

register_device()

static void uhd::device::register_device ( const find_t &  find, const make_t &  make, const device_filter_t  filter  )

static

Register a device into the discovery and factory system.

Parameters

find	a function that discovers devices
make	a factory function that makes a device

Member Data Documentation

_tree

uhd::property_tree::sptr uhd::device::_tree

protected

_type

device_filter_t uhd::device::_type

protected

---

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

• include/uhd/device.hpp