USRP Hardware Driver and USRP Manual Version: 4.0.0.0-0-unknown
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 <functional>
14#include <memory>
15#include <string>
16#include <typeindex>
17#include <vector>
18
19namespace uhd {
20
68template <typename T>
70{
71public:
72 typedef std::function<void(const T&)> subscriber_type;
73 typedef std::function<T(void)> publisher_type;
74 typedef std::function<T(const T&)> coercer_type;
75
76 virtual ~property<T>(void) = 0;
77
88 virtual property<T>& set_coercer(const coercer_type& coercer) = 0;
89
100 virtual property<T>& set_publisher(const publisher_type& publisher) = 0;
101
111 virtual property<T>& add_desired_subscriber(const subscriber_type& subscriber) = 0;
112
122 virtual property<T>& add_coerced_subscriber(const subscriber_type& subscriber) = 0;
123
130 virtual property<T>& update(void) = 0;
131
144 virtual property<T>& set(const T& value) = 0;
145
157 virtual property<T>& set_coerced(const T& value) = 0;
158
167 virtual const T get(void) const = 0;
168
175 virtual const T get_desired(void) const = 0;
176
183 virtual bool empty(void) const = 0;
184};
185
186template <typename T>
188{
189 /* NOP */
190}
191
199struct fs_path : std::string
200{
202 UHD_API fs_path(const char*);
203 UHD_API fs_path(const std::string&);
204 UHD_API std::string leaf(void) const;
206};
207
210
215{
216public:
217 typedef std::shared_ptr<property_tree> sptr;
218
219 enum coerce_mode_t { AUTO_COERCE, MANUAL_COERCE };
220
221 virtual ~property_tree(void) = 0;
222
224 static sptr make(void);
225
227 virtual sptr subtree(const fs_path& path) const = 0;
228
230 virtual void remove(const fs_path& path) = 0;
231
233 virtual bool exists(const fs_path& path) const = 0;
234
236 virtual std::vector<std::string> list(const fs_path& path) const = 0;
237
239 template <typename T>
240 property<T>& create(const fs_path& path, coerce_mode_t coerce_mode = AUTO_COERCE);
241
243 template <typename T>
244 property<T>& access(const fs_path& path);
245
247 template <typename T>
248 std::shared_ptr<property<T>> pop(const fs_path& path);
249
250private:
252 virtual std::shared_ptr<void> _pop(const fs_path& path) = 0;
253
255 virtual void _create(const fs_path& path,
256 const std::shared_ptr<void>& prop,
257 std::type_index prop_type) = 0;
258
260 virtual std::shared_ptr<void>& _access(const fs_path& path) const = 0;
261
263 virtual std::shared_ptr<void>& _access_with_type_check(
264 const fs_path& path, std::type_index expected_prop_type) const = 0;
265};
266
267} // namespace uhd
268
269#include <uhd/property_tree.ipp>
Definition property_tree.hpp:215
std::shared_ptr< property_tree > sptr
Definition property_tree.hpp:217
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)
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:219
@ AUTO_COERCE
Definition property_tree.hpp:219
Definition property_tree.hpp:70
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:73
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:187
virtual property< T > & update(void)=0
std::function< T(const T &)> coercer_type
Definition property_tree.hpp:74
std::function< void(const T &)> subscriber_type
Definition property_tree.hpp:72
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
Definition config.h:67
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:200
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 &)