Difference between revisions of "Function Probe"

From GNU Radio
Jump to: navigation, search
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block 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.
+
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 ==
 
== Parameters ==
Line 12: Line 15:
  
 
; Function Args
 
; 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"'
+
: 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:
:The values will used literally, and generated into the following form:
 
 
     self.block_id.function_name(function_args)
 
     self.block_id.function_name(function_args)
 
:or, if the Block ID is empty,
 
:or, if the Block ID is empty,

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[edit]

(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[edit]

Source Files[edit]