USRP Hardware Driver and USRP Manual Version: 20250207.0.git0dede88c.fc43
UHD and USRP Manual
 
Loading...
Searching...
No Matches
property_tree.hpp
Go to the documentation of this file.
1//
2// Copyright 2011,2014-2016 Ettus Research
3// Copyright 2018 Ettus Research, a National Instruments Company
4// Copyright 2019 Ettus Research, a National Instruments Brand
5//
6// SPDX-License-Identifier: GPL-3.0-or-later
7//
8
9#pragma once
10
11#include <uhd/config.hpp>
13#include <cstddef>
14#include <functional>
15#include <memory>
16#include <string>
17#include <vector>
18
19namespace uhd {
20
26{
27public:
28 virtual ~property_iface() = default;
29};
30
78template <typename T>
80{
81public:
82 typedef std::function<void(const T&)> subscriber_type;
83 typedef std::function<T(void)> publisher_type;
84 typedef std::function<T(const T&)> coercer_type;
85
86 virtual ~property(void) = 0;
87
98 virtual property<T>& set_coercer(const coercer_type& coercer) = 0;
99
110 virtual property<T>& set_publisher(const publisher_type& publisher) = 0;
111
121 virtual property<T>& add_desired_subscriber(const subscriber_type& subscriber) = 0;
122
132 virtual property<T>& add_coerced_subscriber(const subscriber_type& subscriber) = 0;
133
140 virtual property<T>& update(void) = 0;
141
154 virtual property<T>& set(const T& value) = 0;
155
167 virtual property<T>& set_coerced(const T& value) = 0;
168
177 virtual const T get(void) const = 0;
178
185 virtual const T get_desired(void) const = 0;
186
193 virtual bool empty(void) const = 0;
194};
195
196template <typename T>
198{
199 /* NOP */
200}
201
206struct UHD_API_HEADER fs_path : std::string
207{
209 UHD_API fs_path(const char*);
210 UHD_API fs_path(const std::string&);
211 UHD_API std::string leaf(void) const;
213};
214
217
222{
223public:
224 typedef std::shared_ptr<property_tree> sptr;
225
227
228 virtual ~property_tree(void) = 0;
229
231 static sptr make(void);
232
234 virtual sptr subtree(const fs_path& path) const = 0;
235
237 virtual void remove(const fs_path& path) = 0;
238
240 virtual bool exists(const fs_path& path) const = 0;
241
243 virtual std::vector<std::string> list(const fs_path& path) const = 0;
244
246 template <typename T>
247 property<T>& create(const fs_path& path, coerce_mode_t coerce_mode = AUTO_COERCE);
248
250 template <typename T>
251 property<T>& access(const fs_path& path);
252
254 template <typename T>
255 std::shared_ptr<property<T>> pop(const fs_path& path);
256
257private:
259 virtual std::shared_ptr<property_iface> _pop(const fs_path& path) = 0;
260
262 virtual void _create(
263 const fs_path& path, const std::shared_ptr<property_iface>& prop) = 0;
264
266 virtual std::shared_ptr<property_iface>& _access(const fs_path& path) const = 0;
267};
268
269} // namespace uhd
270
271#include <uhd/property_tree.ipp>
Definition property_tree.hpp:26
virtual ~property_iface()=default
Definition property_tree.hpp:222
property< T > & create(const fs_path &path, coerce_mode_t coerce_mode=AUTO_COERCE)
Create a new property entry in the tree.
Definition property_tree.ipp:180
std::shared_ptr< property< T > > pop(const fs_path &path)
Pop a property off the tree, and returns the property.
Definition property_tree.ipp:198
std::shared_ptr< property_tree > sptr
Definition property_tree.hpp:224
virtual ~property_tree(void)=0
virtual std::vector< std::string > list(const fs_path &path) const =0
Get an iterable to all things in the given path.
virtual void remove(const fs_path &path)=0
Remove a property or directory (recursive)
property< T > & access(const fs_path &path)
Get access to a property in the tree.
Definition property_tree.ipp:187
virtual sptr subtree(const fs_path &path) const =0
Get a subtree with a new root starting at path.
static sptr make(void)
Create a new + empty property tree.
virtual bool exists(const fs_path &path) const =0
True if the path exists in the tree.
coerce_mode_t
Definition property_tree.hpp:226
@ AUTO_COERCE
Definition property_tree.hpp:226
@ MANUAL_COERCE
Definition property_tree.hpp:226
Definition property_tree.hpp:80
virtual property< T > & set_coerced(const T &value)=0
virtual property< T > & set_coercer(const coercer_type &coercer)=0
std::function< T(void)> publisher_type
Definition property_tree.hpp:83
virtual const T get_desired(void) const =0
virtual bool empty(void) const =0
virtual property< T > & add_coerced_subscriber(const subscriber_type &subscriber)=0
virtual ~property(void)=0
Definition property_tree.hpp:197
virtual property< T > & update(void)=0
std::function< T(const T &)> coercer_type
Definition property_tree.hpp:84
std::function< void(const T &)> subscriber_type
Definition property_tree.hpp:82
virtual property< T > & add_desired_subscriber(const subscriber_type &subscriber)=0
virtual property< T > & set_publisher(const publisher_type &publisher)=0
virtual property< T > & set(const T &value)=0
virtual const T get(void) const =0
#define UHD_API_HEADER
Definition config.h:88
#define UHD_API
Definition config.h:87
Definition build_info.hpp:12
boost::noncopyable noncopyable
Definition noncopyable.hpp:45
UHD_API fs_path operator/(const fs_path &, const fs_path &)
Definition property_tree.hpp:207
UHD_API fs_path(const char *)
UHD_API std::string leaf(void) const
UHD_API fs_path branch_path(void) const
UHD_API fs_path(void)
UHD_API fs_path(const std::string &)