Namespaces | |
_log | |
cast | |
convert | |
csv | |
math | |
msg | |
niusrprio | |
transport | |
usrp | |
usrp_clock | |
usrprio_rpc | |
Classes | |
struct | assertion_error |
struct | async_metadata_t |
class | atomic_uint32_t |
A 32-bit integer that can be atomically accessed. More... | |
struct | clock_config_t |
class | device |
class | device_addr_t |
class | dict |
struct | environment_error |
struct | exception |
struct | fs_path |
struct | gain_fcns_t |
class | gain_group |
class | gps_ctrl |
class | i2c_iface |
struct | index_error |
struct | io_error |
class | io_type_t |
struct | key_error |
struct | lookup_error |
class | mac_addr_t |
struct | meta_range_t |
class | msg_task |
struct | not_implemented_error |
struct | os_error |
struct | otw_type_t |
class | property |
class | property_tree |
class | range_t |
class | ref_vector |
class | reusable_barrier |
struct | runtime_error |
struct | rx_metadata_t |
class | rx_streamer |
struct | sensor_value_t |
class | simple_claimer |
struct | spi_config_t |
class | spi_iface |
struct | stream_args_t |
struct | stream_cmd_t |
struct | system_error |
class | task |
class | time_spec_t |
struct | tune_request_t |
struct | tune_result_t |
struct | tx_metadata_t |
class | tx_streamer |
struct | type_error |
class | uart_iface |
struct | value_error |
class | wb_iface |
Typedefs | |
typedef std::vector< device_addr_t > | device_addrs_t |
A typedef for a vector of device addresses. More... | |
typedef meta_range_t | gain_range_t |
typedef meta_range_t | freq_range_t |
typedef std::vector< boost::uint8_t > | byte_vector_t |
Enumerations | |
enum | direction_t { RX_DIRECTION, TX_DIRECTION, DX_DIRECTION } |
enum | endianness_t { ENDIANNESS_BIG, ENDIANNESS_LITTLE } |
Functions | |
UHD_API fs_path | operator/ (const fs_path &, const fs_path &) |
UHD_API fs_path | operator/ (const fs_path &, size_t) |
UHD_API device_addrs_t | separate_device_addr (const device_addr_t &dev_addr) |
Separate an indexed device address into a vector of device addresses. More... | |
UHD_API device_addr_t | combine_device_addrs (const device_addrs_t &dev_addrs) |
Combine a vector of device addresses into an indexed device address. More... | |
UHD_API bool | operator== (const time_spec_t &, const time_spec_t &) |
Implement equality_comparable interface. More... | |
UHD_API bool | operator< (const time_spec_t &, const time_spec_t &) |
Implement less_than_comparable interface. More... | |
template<typename Range > | |
Range | sorted (const Range &range) |
template<typename Range > | |
Range | reversed (const Range &range) |
template<typename Range , typename T > | |
bool | has (const Range &range, const T &value) |
template<typename T > | |
T | clip (const T &val, const T &bound1, const T &bound2) |
template<typename T , typename Range > | |
void | assert_has (const Range &range, const T &value, const std::string &what="unknown") |
template<typename T , typename Range > | |
UHD_INLINE void | assert_has (const Range &range, const T &value, const std::string &what) |
UHD_INLINE bool | spin_wait_with_timeout (atomic_uint32_t &cond, boost::uint32_t value, const double timeout) |
boost::uint16_t | byteswap (boost::uint16_t) |
perform a byteswap on a 16 bit integer More... | |
boost::uint32_t | byteswap (boost::uint32_t) |
perform a byteswap on a 32 bit integer More... | |
boost::uint64_t | byteswap (boost::uint64_t) |
perform a byteswap on a 64 bit integer More... | |
template<typename T > | |
T | ntohx (T) |
network to host: short, long, or long-long More... | |
template<typename T > | |
T | htonx (T) |
host to network: short, long, or long-long More... | |
template<typename T > | |
T | wtohx (T) |
worknet to host: short, long, or long-long More... | |
template<typename T > | |
T | htowx (T) |
host to worknet: short, long, or long-long More... | |
UHD_API std::string | get_tmp_path (void) |
Get a string representing the system's temporary directory. More... | |
UHD_API std::string | get_app_path (void) |
Get a string representing the system's appdata directory. More... | |
UHD_API std::string | get_pkg_path (void) |
Get a string representing the system's pkg directory. More... | |
std::vector< fs::path > | get_module_paths (void) |
Get UHD library paths. More... | |
UHD_API std::string | get_images_dir (const std::string search_paths) |
UHD_API std::string | find_image_path (const std::string &image_name, const std::string search_paths="") |
UHD_API std::string | find_utility (std::string name) |
UHD_API std::string | print_utility_error (std::string name) |
boost::int32_t | get_process_id () |
boost::uint32_t | get_host_id () |
boost::uint32_t | get_process_hash () |
UHD_API void | set_thread_priority (float priority=default_thread_priority, bool realtime=true) |
UHD_API bool | set_thread_priority_safe (float priority=default_thread_priority, bool realtime=true) |
Define common exceptions used throughout the code:
The code() provides an error code which allows the application the option of printing a cryptic error message from the 1990s.
The dynamic_clone() and dynamic_throw() methods allow us to: catch an exception by dynamic type (i.e. derived class), save it, and later rethrow it, knowing only the static type (i.e. base class), and then finally to catch it again using the derived type.
http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n2106.html
Useful templated functions, classes, and constants. Some of these overlap with the STL, but these are created with Boost for portability. Many of the range wrapper functions come with versions of boost >= 1.43.
typedef std::vector<boost::uint8_t> uhd::byte_vector_t |
Byte vector typedef for passing data in and out of I2C interfaces.
typedef std::vector<device_addr_t> uhd::device_addrs_t |
A typedef for a vector of device addresses.
typedef meta_range_t uhd::freq_range_t |
typedef meta_range_t uhd::gain_range_t |
enum uhd::direction_t |
enum uhd::endianness_t |
UHD_INLINE void uhd::assert_has | ( | const Range & | range, |
const T & | value, | ||
const std::string & | what = "unknown" |
||
) |
Check that an element is found in a container. If not, throw a meaningful assertion error. The "what" in the error will show what is being set and a list of known good values.
range | a list of possible settings |
value | an element that may be in the list |
what | a description of what the value is |
assertion_error | when elem not in list |
void uhd::assert_has | ( | const Range & | range, |
const T & | value, | ||
const std::string & | what = "unknown" |
||
) |
Check that an element is found in a container. If not, throw a meaningful assertion error. The "what" in the error will show what is being set and a list of known good values.
range | a list of possible settings |
value | an element that may be in the list |
what | a description of what the value is |
assertion_error | when elem not in list |
UHD_INLINE boost::uint16_t uhd::byteswap | ( | boost::uint16_t | x | ) |
perform a byteswap on a 16 bit integer
UHD_INLINE boost::uint32_t uhd::byteswap | ( | boost::uint32_t | x | ) |
perform a byteswap on a 32 bit integer
UHD_INLINE boost::uint64_t uhd::byteswap | ( | boost::uint64_t | x | ) |
perform a byteswap on a 64 bit integer
|
inline |
A templated clip implementation.
val | the value to clip between an upper and lower limit |
bound1 | the upper or lower bound |
bound2 | the upper or lower bound |
UHD_API device_addr_t uhd::combine_device_addrs | ( | const device_addrs_t & | dev_addrs | ) |
Combine a vector of device addresses into an indexed device address.
UHD_API std::string uhd::find_image_path | ( | const std::string & | image_name, |
const std::string | search_paths = "" |
||
) |
Return the full path to particular UHD binary image.
This function searches for the passed image name, and returns an absolute path to it. The returned path is guaranteed to exist. The caller can also provide a full path to the image in the argument, and this function will validate it and convert it to an absolute system path.
image_name | The name of the file to search for, or the full path. |
search_paths | Hints / paths to use when calling get_images_dir |
exception | uhd::io_error if the file was not found. |
UHD_API std::string uhd::find_utility | ( | std::string | name | ) |
Search for the location of a particular UHD utility. The utility must be installed in the uhd/utils
directory.
the | name of the utility to search for |
UHD_API std::string uhd::get_app_path | ( | void | ) |
Get a string representing the system's appdata directory.
boost::uint32_t uhd::get_host_id | ( | ) |
UHD_API std::string uhd::get_images_dir | ( | const std::string | search_paths | ) |
Return the UHD images directory path.
This function returns the UHD images installation path on this system. The returned directory path is guaranteed to exist (assuming a valid path is found). This function will look for a directory that exists using this order of precedence:
1) UHD_IMAGES_DIR
environment variable 2) Any paths passed to this function via `search_paths' 3) UHD package path / share / uhd / images
The search_paths
parameter may contain Windows registry keys. If no directory is found, an empty string is returned.
search_paths | A comma-separated list of hints for paths to include. |
std::vector<fs::path> uhd::get_module_paths | ( | void | ) |
Get UHD library paths.
UHD_API std::string uhd::get_pkg_path | ( | void | ) |
Get a string representing the system's pkg directory.
boost::uint32_t uhd::get_process_hash | ( | ) |
boost::int32_t uhd::get_process_id | ( | ) |
UHD_API std::string uhd::get_tmp_path | ( | void | ) |
Get a string representing the system's temporary directory.
|
inline |
Is the value found within the elements in this range?
Uses std::find to search the iterable for an element.
range | the elements to search through |
value | the match to look for in the range |
T uhd::htonx | ( | T | ) |
host to network: short, long, or long-long
T uhd::htowx | ( | T | ) |
host to worknet: short, long, or long-long
T uhd::ntohx | ( | T | ) |
network to host: short, long, or long-long
UHD_API bool uhd::operator< | ( | const time_spec_t & | , |
const time_spec_t & | |||
) |
Implement less_than_comparable interface.
UHD_API bool uhd::operator== | ( | const time_spec_t & | , |
const time_spec_t & | |||
) |
Implement equality_comparable interface.
UHD_API std::string uhd::print_utility_error | ( | std::string | name | ) |
Return an error string recommending the user run the utility. The error string will include the full path to the utility to run.
|
inline |
A wrapper around std::reverse that takes a range instead of an iterator.
The elements are reversed into descending order using the less-than operator. This wrapper reverses the elements non-destructively into a new range. Based on the builtin python function reversed(...)
range | the range of elements to be reversed |
UHD_API device_addrs_t uhd::separate_device_addr | ( | const device_addr_t & | dev_addr | ) |
Separate an indexed device address into a vector of device addresses.
UHD_API void uhd::set_thread_priority | ( | float | priority = default_thread_priority , |
bool | realtime = true |
||
) |
Set the scheduling priority on the current thread.
A new thread or calling process should make this call with the defailts this to enable realtime scheduling.
A priority of zero corresponds to normal priority. Positive priority values are higher than normal. Negative priority values are lower than normal.
priority | a value between -1 and 1 |
realtime | true to use realtime mode |
exception | on set priority failure |
UHD_API bool uhd::set_thread_priority_safe | ( | float | priority = default_thread_priority , |
bool | realtime = true |
||
) |
Set the scheduling priority on the current thread. Same as set_thread_priority but does not throw on failure.
|
inline |
A wrapper around std::sort that takes a range instead of an iterator.
The elements are sorted into ascending order using the less-than operator. This wrapper sorts the elements non-destructively into a new range. Based on the builtin python function sorted(...)
range | the range of elements to be sorted |
UHD_INLINE bool uhd::spin_wait_with_timeout | ( | atomic_uint32_t & | cond, |
boost::uint32_t | value, | ||
const double | timeout | ||
) |
Spin-wait on a condition with a timeout.
cond | an atomic variable to compare |
value | compare to atomic for true/false |
timeout | the timeout in seconds |
T uhd::wtohx | ( | T | ) |
worknet to host: short, long, or long-long