Copy: 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...")
 
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
When enabled (default), this block copies its input to its output. When disabled, this block drops its input on the floor.
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.


== 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>
; Type
:* Complex
:* Float
:* Int
:* Short
:* Byte
; Enabled (''R'')
: Whether or not the input is copied to the output, or just dropped.
; Show Msg Ports
: This block has an "enabled" message port that can be used to turn it on or off.
== Message Ports ==
; en
: The 'Enabled' parameter of this block can be changed by sending a message at this port. Sending a Message PMT of '''pmt.from_bool(False)''' to this port via Message Strobe can disable the block. '''pmt.from_bool(True)''' can enable the block.
== Example Flowgraph ==
The following graph depicts the usage of the copy block.


; Param 1 (''R'')
[[File:Copy Msg Flowgraph.PNG]]
: 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
Initially, copy is enabled, so the data is transferred to the output of the copy block.
: blah blah blah


== Example Flowgraph ==
[[File:Copy_Output_1.PNG| 400px]]


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.
But when the block receives the msg of '''pmt.from_bool(False)''' after 2.5 seconds, it starts dropping all of the upcoming data.


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


; C++ files
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/lib/copy_impl.cc lib_copy_impl.cc]


; Header files
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/lib/copy_impl.h copy_impl.h]


; Public header files
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/include/gnuradio/blocks/copy.h copy.h]


; Block definition
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-blocks/grc/blocks_copy.block.yml blocks_copy.block.yml]

Latest revision as of 06:49, 22 February 2022

When enabled (default), this block copies its input to its output. When disabled, this block drops its input on the floor.

Parameters

(R): Run-time adjustable

Type
  • Complex
  • Float
  • Int
  • Short
  • Byte
Enabled (R)
Whether or not the input is copied to the output, or just dropped.
Show Msg Ports
This block has an "enabled" message port that can be used to turn it on or off.

Message Ports

en
The 'Enabled' parameter of this block can be changed by sending a message at this port. Sending a Message PMT of pmt.from_bool(False) to this port via Message Strobe can disable the block. pmt.from_bool(True) can enable the block.

Example Flowgraph

The following graph depicts the usage of the copy block.

Copy Msg Flowgraph.PNG

Initially, copy is enabled, so the data is transferred to the output of the copy block.

Copy Output 1.PNG

But when the block receives the msg of pmt.from_bool(False) after 2.5 seconds, it starts dropping all of the upcoming data.

Source Files

C++ files
lib_copy_impl.cc
Header files
copy_impl.h
Public header files
copy.h
Block definition
blocks_copy.block.yml
Retrieved from "https://wiki.gnuradio.org/index.php?title=Copy&oldid=11535"