USRP Hardware Driver and USRP Manual  Version: 4.0.0.0-172-g5802a362f
UHD and USRP Manual
uhd::rfnoc::dirtifier_t Class Reference

#include <uhd/rfnoc/dirtifier.hpp>

Inheritance diagram for uhd::rfnoc::dirtifier_t:
uhd::rfnoc::property_base_t

Public Member Functions

 dirtifier_t ()
 
bool is_dirty () const
 This property is always dirty. More...
 
bool is_valid () const
 This property is always invalid. More...
 
bool equal (property_base_t *) const
 This property is never equal to anything else. More...
 
void force_dirty ()
 Always dirty, so this can be called as often as we like. More...
 
void set_from_str (const std::string &)
 
- 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...
 
virtual std::unique_ptr< property_base_tclone (res_source_info)
 Create a copy of this property. More...
 

Additional Inherited Members

- Public Types inherited from uhd::rfnoc::property_base_t
enum  access_t { NONE, RO = 0x1, RW = 0x3, RWLOCKED = 0x5 }
 

Detailed Description

This is a special class for property that is always dirty. This is useful to force property resolutions in certain cases.

Note: This has nothing to do with 'dirtify' in the CGI/graphics sense.

Constructor & Destructor Documentation

◆ dirtifier_t()

uhd::rfnoc::dirtifier_t::dirtifier_t ( )
inline

Member Function Documentation

◆ equal()

bool uhd::rfnoc::dirtifier_t::equal ( property_base_t ) const
inlinevirtual

This property is never equal to anything else.

Implements uhd::rfnoc::property_base_t.

◆ force_dirty()

void uhd::rfnoc::dirtifier_t::force_dirty ( )
inlinevirtual

Always dirty, so this can be called as often as we like.

Implements uhd::rfnoc::property_base_t.

◆ is_dirty()

bool uhd::rfnoc::dirtifier_t::is_dirty ( ) const
inlinevirtual

This property is always dirty.

Implements uhd::rfnoc::property_base_t.

◆ is_valid()

bool uhd::rfnoc::dirtifier_t::is_valid ( ) const
inlinevirtual

This property is always invalid.

Implements uhd::rfnoc::property_base_t.

◆ set_from_str()

void uhd::rfnoc::dirtifier_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 file: