USRP Hardware Driver and USRP Manual  Version:
UHD and USRP Manual
uhd::device_addr_t Class Reference

#include <uhd/types/device_addr.hpp>

Inheritance diagram for uhd::device_addr_t:
uhd::dict< std::string, std::string >

Public Member Functions

 device_addr_t (const std::string &args="")
 device_addr_t (const char *args)
 device_addr_t (const std::map< std::string, std::string > &info)
std::string to_pp_string (void) const
std::string to_string (void) const
template<typename T >
cast (const std::string &key, const T &def) const
- Public Member Functions inherited from uhd::dict< std::string, std::string >
 dict (void)
 dict (InputIterator first, InputIterator last)
std::size_t size (void) const
std::vector< std::string > keys (void) const
std::vector< std::string > vals (void) const
bool has_key (const std::string &key) const
const std::string & get (const std::string &key, const std::string &other) const
const std::string & get (const std::string &key) const
void set (const std::string &key, const std::string &val)
const std::string & operator[] (const std::string &key) const
std::string & operator[] (const std::string &key)
bool operator== (const dict< std::string, std::string > &other) const
bool operator!= (const dict< std::string, std::string > &other) const
std::string pop (const std::string &key)
void update (const dict< std::string, std::string > &new_dict, bool fail_on_conflict=true)
 operator std::map< std::string, std::string > () const

Detailed Description

Mapping of key/value pairs for locating devices on the system. When left empty, the device discovery routines will search all available transports on the system (ethernet, usb...).

To narrow down the discovery process to a particular device, specify a transport key/value pair specific to your device.

  • Ex, to find a usrp2: my_dev_addr["addr"] = [resolvable_hostname_or_ip]

The device address can also be used to pass arguments into the transport layer control to set (for example) buffer sizes.

An arguments string, is a way to represent a device address using a single string with delimiter characters.

  • Ex: addr=
  • Ex: addr=, recv_buff_size=1e6

Constructor & Destructor Documentation

◆ device_addr_t() [1/3]

uhd::device_addr_t::device_addr_t ( const std::string &  args = "")

Create a device address from an args string.

argsthe arguments string

◆ device_addr_t() [2/3]

uhd::device_addr_t::device_addr_t ( const char *  args)

Create a device address from an args string.

argsthe arguments string

◆ device_addr_t() [3/3]

uhd::device_addr_t::device_addr_t ( const std::map< std::string, std::string > &  info)

Create a device address from a std::map

infothe device info map

Member Function Documentation

◆ cast()

template<typename T >
T uhd::device_addr_t::cast ( const std::string &  key,
const T &  def 
) const

Lexically cast a parameter to the specified type, or use the default value if the key is not found.

keythe key as one of the address parameters
defthe value to use when key is not present
the casted value as type T or the default
errorwhen the parameter cannot be casted

◆ to_pp_string()

std::string uhd::device_addr_t::to_pp_string ( void  ) const

Convert a device address into a pretty print string.

a printable string representing the device address

◆ to_string()

std::string uhd::device_addr_t::to_string ( void  ) const

Convert the device address into an args string. The args string contains delimiter symbols.

a string with delimiter markup

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