Function Probe: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
(Created page with "Category:Block Docs Category:Stub Docs This is the template for the "Page-per-block Docs". This first section should describe what the block...")
 
No edit summary
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
Periodically probe a function and set its value to this variable. To poll a stream for a level, use this with the [[Probe Signal]] block.
This is the template for the [[:Category:Block_Docs|"Page-per-block Docs"]].  This first section should describe what the block does and how to use it, using however many paragraphs necessary. Note that the title of the wiki page should match the block's name in GRC, i.e. the one defined in the block's .grc file.  Look at the [[FFT]] Block for a good example.


As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
Polling interval is relative to the computer clock. Where the flowgraph is running faster or slower than real time (e.g., no throttle or SDR), the computer clock
will not correspond to the simulated time implied by the sample stream.


== Parameters ==
== Parameters ==
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>


; Param 1 (''R'')
; Block ID
: Description of parameter, provide any tips or recommended values. Note that the name of the parameter above should match the param's label that shows up in grc (e.g. Sample Rate).
: ID of another block in this flow graph. An empty Block ID references the flow graph itself.


; Param 2
; Function Name
: blah blah blah
: Name of a class method of the block labeled in Block ID.


== Example Flowgraph ==
; Function Args
: Parameters passed into the function specified under Function Name. For a function with no arguments, leave function args blank. When passing a string for the function arguments, quote the string literal: '"arg"'.  The values will used literally, and generated into the following form:
    self.block_id.function_name(function_args)
:or, if the Block ID is empty,
    self.function_name(function_args)


Insert description of flowgraph here, then show a screenshot of the flowgraph and the output if there is an interesting GUI.  Currently we have no standard method of uploading the actual flowgraph to the wiki or git repo, unfortunately.  The plan is to have an example flowgraph showing how the block might be used, for every block, and the flowgraphs will live in the git repo.
; Poll Rate
: in Hz.   


== Source Files ==
; Initial Value (''R'')
: Initial value of function


; C++ fileshttps://wiki.gnuradio.org/index.php/SISO
== Example Flowgraph ==


: [https://github.com/gnuradio/gnuradio TODO]
== Source Files ==
 
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
 
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
 
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]

Latest revision as of 12:21, 1 November 2020

Periodically probe a function and set its value to this variable. To poll a stream for a level, use this with the Probe Signal block.

Polling interval is relative to the computer clock. Where the flowgraph is running faster or slower than real time (e.g., no throttle or SDR), the computer clock will not correspond to the simulated time implied by the sample stream.

Parameters

(R): Run-time adjustable

Block ID
ID of another block in this flow graph. An empty Block ID references the flow graph itself.
Function Name
Name of a class method of the block labeled in Block ID.
Function Args
Parameters passed into the function specified under Function Name. For a function with no arguments, leave function args blank. When passing a string for the function arguments, quote the string literal: '"arg"'. The values will used literally, and generated into the following form:
   self.block_id.function_name(function_args)
or, if the Block ID is empty,
   self.function_name(function_args)
Poll Rate
in Hz.
Initial Value (R)
Initial value of function

Example Flowgraph

Source Files

Retrieved from "https://wiki.gnuradio.org/index.php?title=Function_Probe&oldid=7695"