USRP Hardware Driver and USRP Manual  Version: 4.0.0.0-170-gd398fe465
UHD and USRP Manual
uhd::rfnoc::property_t< data_t > Class Template Reference

#include <uhd/rfnoc/property.hpp>

Inheritance diagram for uhd::rfnoc::property_t< data_t >:
uhd::rfnoc::property_base_t

Public Types

using value_type = data_t
 We want to be good C++ citizens. More...
 
- Public Types inherited from uhd::rfnoc::property_base_t
enum  access_t { NONE, RO = 0x1, RW = 0x3, RWLOCKED = 0x5 }
 

Public Member Functions

 property_t (const std::string &id, data_t &&value, const res_source_info &source_info)
 
 property_t (const std::string &id, const data_t &value, const res_source_info &source_info)
 
 property_t (const std::string &id, const res_source_info &source_info)
 
 property_t (const property_t< data_t > &prop)=default
 
bool is_dirty () const
 Returns the dirty state of this property. More...
 
bool is_valid () const
 Query this property's valid flag. More...
 
bool equal (property_base_t *rhs) const
 Return true if rhs has the same type and value. More...
 
std::unique_ptr< property_base_tclone (res_source_info new_src_info) override
 Create a copy of this property. More...
 
void set_from_str (const std::string &new_val_str)
 
void set (const data_t &value)
 Returns the source info for the property. More...
 
void force_dirty ()
 
const data_t & get () const
 Get the value of this property. More...
 
 operator const data_t & () const
 
bool operator== (const data_t &rhs)
 
property_t< data_t > & operator= (const data_t &value)
 
- Public Member Functions inherited from uhd::rfnoc::property_base_t
 property_base_t (const std::string &id, const res_source_info &source_info)
 
const std::string & get_id () const
 Gets the ID (name) of this property. More...
 
const res_source_infoget_src_info () const
 Return the source info for this property. More...
 
bool read_access_granted () const
 Returns true if this property can be read. More...
 
bool write_access_granted () const
 Returns true if this property can be written to. More...
 
access_t get_access_mode () const
 Return the current access mode. More...
 

Detailed Description

template<typename data_t>
class uhd::rfnoc::property_t< data_t >

An encapsulation class for a block property.

Member Typedef Documentation

◆ value_type

template<typename data_t>
using uhd::rfnoc::property_t< data_t >::value_type = data_t

We want to be good C++ citizens.

Constructor & Destructor Documentation

◆ property_t() [1/4]

template<typename data_t>
uhd::rfnoc::property_t< data_t >::property_t ( const std::string &  id,
data_t &&  value,
const res_source_info source_info 
)

◆ property_t() [2/4]

template<typename data_t>
uhd::rfnoc::property_t< data_t >::property_t ( const std::string &  id,
const data_t &  value,
const res_source_info source_info 
)

◆ property_t() [3/4]

template<typename data_t>
uhd::rfnoc::property_t< data_t >::property_t ( const std::string &  id,
const res_source_info source_info 
)

◆ property_t() [4/4]

template<typename data_t>
uhd::rfnoc::property_t< data_t >::property_t ( const property_t< data_t > &  prop)
default

Member Function Documentation

◆ clone()

template<typename data_t>
std::unique_ptr<property_base_t> uhd::rfnoc::property_t< data_t >::clone ( res_source_info  )
inlineoverridevirtual

Create a copy of this property.

Reimplemented from uhd::rfnoc::property_base_t.

◆ equal()

template<typename data_t>
bool uhd::rfnoc::property_t< data_t >::equal ( property_base_t rhs) const
inlinevirtual

Return true if rhs has the same type and value.

Implements uhd::rfnoc::property_base_t.

◆ force_dirty()

template<typename data_t>
void uhd::rfnoc::property_t< data_t >::force_dirty ( )
inlinevirtual

◆ get()

template<typename data_t>
const data_t& uhd::rfnoc::property_t< data_t >::get ( void  ) const
inline

Get the value of this property.

◆ is_dirty()

template<typename data_t>
bool uhd::rfnoc::property_t< data_t >::is_dirty ( ) const
inlinevirtual

Returns the dirty state of this property.

Implements uhd::rfnoc::property_base_t.

◆ is_valid()

template<typename data_t>
bool uhd::rfnoc::property_t< data_t >::is_valid ( ) const
inlinevirtual

Query this property's valid flag.

Implements uhd::rfnoc::property_base_t.

◆ operator const data_t &()

template<typename data_t>
uhd::rfnoc::property_t< data_t >::operator const data_t & ( ) const
inline

◆ operator=()

template<typename data_t>
property_t<data_t>& uhd::rfnoc::property_t< data_t >::operator= ( const data_t &  value)
inline

◆ operator==()

template<typename data_t>
bool uhd::rfnoc::property_t< data_t >::operator== ( const data_t &  rhs)
inline

◆ set()

template<typename data_t>
void uhd::rfnoc::property_t< data_t >::set ( const data_t &  value)
inline

Returns the source info for the property.

Set the value of this property

◆ set_from_str()

template<typename data_t>
void uhd::rfnoc::property_t< data_t >::set_from_str ( const std::string &  new_val_str)
inlinevirtual

Set this property's value using a string

This requires the underlying property type to be convertible from a string.

Exceptions
uhd::runtime_errorif the underlying type has no conversion from a string

Implements uhd::rfnoc::property_base_t.


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