rpcbasic_register_set
rpcbasic_base
gnuradio/rpcregisterhelpers.h
typename T
typename Tto
std::string std::string rpcbasic_register_set< T, Tto >::d_id d_id rpcbasic_register_set::d_id
pmt::pmt_t pmt::pmt_t rpcbasic_register_set< T, Tto >::d_min d_min rpcbasic_register_set::d_min
pmt::pmt_t pmt::pmt_t rpcbasic_register_set< T, Tto >::d_max d_max rpcbasic_register_set::d_max
pmt::pmt_t pmt::pmt_t rpcbasic_register_set< T, Tto >::d_def d_def rpcbasic_register_set::d_def
std::string std::string rpcbasic_register_set< T, Tto >::d_units d_units rpcbasic_register_set::d_units
std::string std::string rpcbasic_register_set< T, Tto >::d_desc d_desc rpcbasic_register_set::d_desc
priv_lvl_t priv_lvl_t rpcbasic_register_set< T, Tto >::d_minpriv d_minpriv rpcbasic_register_set::d_minpriv
DisplayType DisplayType rpcbasic_register_set< T, Tto >::d_display d_display rpcbasic_register_set::d_display
T * T* rpcbasic_register_set< T, Tto >::d_object d_object rpcbasic_register_set::d_object
rpcbasic_register_set< T, Tto >::rpcbasic_register_set
(const std::string &block_alias, const char *functionbase, void(T::*function)(Tto), const pmt::pmt_t &min, const pmt::pmt_t &max, const pmt::pmt_t &def, const char *units_="", const char *desc_="", priv_lvl_t minpriv_=RPC_PRIVLVL_MIN, DisplayType display_=DISPNULL)
rpcbasic_register_set
rpcbasic_register_set::rpcbasic_register_set
const std::string & block_alias
const char * functionbase
void(T::*)(Tto) function
const pmt::pmt_t & min
const pmt::pmt_t & max
const pmt::pmt_t & def
const char * units_ ""
const char * desc_ ""
priv_lvl_t minpriv_ RPC_PRIVLVL_MIN
DisplayType display_ DISPNULL

Adds the ability to set the variable over ControlPort.

This constructor is specifically for gr::block's to use to add settable variables to ControlPort. Generally meant to be used in gr::block::setup_rpc.

Uses the block's alias to create the ControlPort interface. This alias is cross-referenced by the global_block_registry (static variable of type gr::block_registry) to get the pointer to the block.

block_alias

Block's alias; use alias() to get it from the block.

functionbase

The name of the function that we'll access over ControlPort

function

A function pointer to the real function accessed when called something like: &[block class]::set_[variable]()

min

Expected minimum value the parameter can hold

max

Expected maximum value the parameter can hold

def

Expected default value the parameter can hold

units_

A string to describe what units to represent the variable with

desc_

A string to describing the variable.

minpriv_

The required minimum privilege level

display_

The display mask

rpcbasic_register_set< T, Tto >::def
DISPNULL
rpcmanager::get
global_block_registry
rpcserver_booter_base::i
pmt::intern
rpcbasic_register_set< T, Tto >::max
rpcbasic_register_set< T, Tto >::min
rpcserver_base::registerConfigureCallback
RPC_PRIVLVL_MIN
rpcbasic_register_set< T, Tto >::rpcbasic_register_set
(const std::string &name, const char *functionbase, T *obj, void(T::*function)(Tto), const pmt::pmt_t &min, const pmt::pmt_t &max, const pmt::pmt_t &def, const char *units_="", const char *desc_="", priv_lvl_t minpriv_=RPC_PRIVLVL_MIN, DisplayType display_=DISPNULL)
rpcbasic_register_set
rpcbasic_register_set::rpcbasic_register_set
const std::string & name
const char * functionbase
T * obj
void(T::*)(Tto) function
const pmt::pmt_t & min
const pmt::pmt_t & max
const pmt::pmt_t & def
const char * units_ ""
const char * desc_ ""
priv_lvl_t minpriv_ RPC_PRIVLVL_MIN
DisplayType display_ DISPNULL

Adds the ability to set the variable over ControlPort.

Allows us to add non gr::block related objects to ControlPort. Instead of using the block's alias, we give it a `name` and the actual pointer to the object as `obj`. We just need to make sure that the pointer to this object is always valid.

name

Name of the object being set up for ControlPort access

functionbase

The name of the function that we'll access over ControlPort

obj

A pointer to the object itself

function

A function pointer to the real function accessed when called something like: &[block class]::set_[variable]()

min

Expected minimum value the parameter can hold

max

Expected maximum value the parameter can hold

def

Expected default value the parameter can hold

units_

A string to describe what units to represent the variable with

desc_

A string to describing the variable.

minpriv_

The required minimum privilege level

display_

The display mask

rpcbasic_register_set< T, Tto >::def
DISPNULL
rpcmanager::get
rpcserver_booter_base::i
rpcbasic_register_set< T, Tto >::max
rpcbasic_register_set< T, Tto >::min
rpcserver_base::registerConfigureCallback
RPC_PRIVLVL_MIN
rpcbasic_register_set< T, Tto >::~rpcbasic_register_set
() override
~rpcbasic_register_set
rpcbasic_register_set::~rpcbasic_register_set
rpcmanager::get
rpcserver_booter_base::i
rpcserver_base::unregisterConfigureCallback
pmt::pmt_t pmt::pmt_t rpcbasic_register_set< T, Tto >::min () const min rpcbasic_register_set::min rpcbasic_register_set< T, Tto >::rpcbasic_register_set rpcbasic_register_set< T, Tto >::rpcbasic_register_set
pmt::pmt_t pmt::pmt_t rpcbasic_register_set< T, Tto >::max () const max rpcbasic_register_set::max rpcbasic_register_set< T, Tto >::rpcbasic_register_set rpcbasic_register_set< T, Tto >::rpcbasic_register_set
pmt::pmt_t pmt::pmt_t rpcbasic_register_set< T, Tto >::def () const def rpcbasic_register_set::def rpcbasic_register_set< T, Tto >::rpcbasic_register_set rpcbasic_register_set< T, Tto >::rpcbasic_register_set
std::string std::string rpcbasic_register_set< T, Tto >::units () const units rpcbasic_register_set::units
std::string std::string rpcbasic_register_set< T, Tto >::description () const description rpcbasic_register_set::description
priv_lvl_t priv_lvl_t rpcbasic_register_set< T, Tto >::privilege_level () const privilege_level rpcbasic_register_set::privilege_level
DisplayType DisplayType rpcbasic_register_set< T, Tto >::default_display () const default_display rpcbasic_register_set::default_display
void void rpcbasic_register_set< T, Tto >::set_min (pmt::pmt_t p) set_min rpcbasic_register_set::set_min pmt::pmt_t p
void void rpcbasic_register_set< T, Tto >::set_max (pmt::pmt_t p) set_max rpcbasic_register_set::set_max pmt::pmt_t p
void void rpcbasic_register_set< T, Tto >::set_def (pmt::pmt_t p) set_def rpcbasic_register_set::set_def pmt::pmt_t p
void void rpcbasic_register_set< T, Tto >::units (std::string u) units rpcbasic_register_set::units std::string u
void void rpcbasic_register_set< T, Tto >::description (std::string d) description rpcbasic_register_set::description std::string d
void void rpcbasic_register_set< T, Tto >::privilege_level (priv_lvl_t p) privilege_level rpcbasic_register_set::privilege_level priv_lvl_t p
void void rpcbasic_register_set< T, Tto >::default_display (DisplayType d) default_display rpcbasic_register_set::default_display DisplayType d

Registers a 'set' function to set a parameter over ControlPort.

This class allows us to remotely set a value or parameter of the block over ControlPort. The set occurs by calling a setter accessor function of the class, usually set_[variable](), which is passed in as `function`.

We can set the (expected) minimum (`min`), maximum (`max`), and default (`def`) of the variables being set. These values are not enforced, however, but can be useful for setting up graphs and other ways of bounding the data.

This class also allows us to provide information to the user about the variable being set, such as an appropriate unit (`units_`) as well as a description (`desc_`) about what the variable does.

The privilege (`minpriv_`) level is the minimum privilege level a remote must identify with to be able to call this function.

We also provide display hints (`display_`), which can be used by the ControlPort client application to know how to best display or even print the data. This is a mask of options for variables set in rpccallbackregister_base.h. The mask is defined by one of the "DisplayType Plotting Types" and or'd with any of the "DisplayType Options" features. See "Display Options" in ControlPort for details.

rpcbasic_base
rpcbasic_register_set< T, Tto >
rpcbasic_base
rpcbasic_register_set< T, Tto >
- rpcbasic_register_set
  d_def
- rpcbasic_register_set
  d_desc
- rpcbasic_register_set
  d_display
- rpcbasic_register_set
  d_id
- rpcbasic_register_set
  d_max
- rpcbasic_register_set
  d_min
- rpcbasic_register_set
  d_minpriv
- rpcbasic_register_set
  d_object
- rpcbasic_register_set
  d_units
- rpcbasic_register_set
  def
- rpcbasic_register_set
  default_display
- rpcbasic_register_set
  default_display
- rpcbasic_register_set
  description
- rpcbasic_register_set
  description
- rpcbasic_register_set
  max
- rpcbasic_register_set
  min
- rpcbasic_register_set
  privilege_level
- rpcbasic_register_set
  privilege_level
- rpcbasic_register_set
  rpcbasic_base
- rpcbasic_register_set
  rpcbasic_register_set
- rpcbasic_register_set
  rpcbasic_register_set
- rpcbasic_register_set
  set_def
- rpcbasic_register_set
  set_max
- rpcbasic_register_set
  set_min
- rpcbasic_register_set
  units
- rpcbasic_register_set
  units
- rpcbasic_register_set
  ~rpcbasic_base
- rpcbasic_register_set
  ~rpcbasic_register_set