Virtual Sink: 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...")
 
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
When paired with a [[Virtual Source]] block, this is essentially the same as drawing a wire between two blocks. This block can be useful for tidying up a complex flowgraph.  
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.
This block does not support C++ output, so it cannot be used when the output language of a flowgraph in GRC is C++.
 
As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.


== Parameters ==
== Parameters ==
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
; Stream ID
 
: Specifies the stream ID of the virtual source to read from. To link the stream with a virtual source, the same value of stream ID must be set in the corresponding source and sink blocks.
; Param 1 (''R'')
: 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).
 
; Param 2
: blah blah blah


== Example Flowgraph ==
== Example Flowgraph ==


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.
[[File:Bpsk_stage6_fg.png|800 px]]


== Source Files ==
== Source Files ==


; C++ files
; Python files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/grc/core/blocks/virtual.py virtual.py]


; Header files
; Header files

Latest revision as of 05:43, 20 January 2022

When paired with a Virtual Source block, this is essentially the same as drawing a wire between two blocks. This block can be useful for tidying up a complex flowgraph. This block does not support C++ output, so it cannot be used when the output language of a flowgraph in GRC is C++.

Parameters

Stream ID
Specifies the stream ID of the virtual source to read from. To link the stream with a virtual source, the same value of stream ID must be set in the corresponding source and sink blocks.

Example Flowgraph

Bpsk stage6 fg.png

Source Files

Python files
virtual.py
Header files
TODO
Public header files
TODO
Block definition
TODO
Retrieved from "https://wiki.gnuradio.org/index.php?title=Virtual_Sink&oldid=10329"