Difference between revisions of "FEC Tagged Encoder"

From GNU Radio
Jump to: navigation, search
 
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
[[Category:Stub Docs]]
+
Creates the encoder block for use in GNU Radio flowgraphs from a given FECAPI object derived from the generic_encoder class.
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.
+
Generally, we would use the fec.extended_encoder Python implementation to instantiate this. The extended_encoder wraps up a few more details, like taking care of puncturing as well as the encoder itself.
  
 
== Parameters ==
 
== Parameters ==
  
 
; Constituent Encoder
 
; Constituent Encoder
: 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).
+
: An FECAPI encoder object child of the generic_encoder class.
  
 
; MTU (bytes)
 
; MTU (bytes)
: blah blah blah
+
: The Maximum Transmission Unit (MTU) of the input frame that the block will be able to process. Specified in bytes and defaults to 1500.
  
 
; Length Tag Name
 
; Length Tag Name
:  
+
: Key name of the tagged stream frame size.
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==
Line 23: Line 22:
  
 
; C++ files
 
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/lib/tagged_encoder_impl.cc]
  
 
; Header files
 
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/lib/tagged_encoder_impl.h]
  
 
; Public header files
 
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/include/gnuradio/fec/tagged_encoder.h]
  
 
; Block definition
 
; Block definition
 
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/grc/fec_tagged_encoder.block.yml]
 
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/grc/fec_tagged_encoder.block.yml]

Latest revision as of 09:11, 12 September 2019

Creates the encoder block for use in GNU Radio flowgraphs from a given FECAPI object derived from the generic_encoder class.

Generally, we would use the fec.extended_encoder Python implementation to instantiate this. The extended_encoder wraps up a few more details, like taking care of puncturing as well as the encoder itself.

Parameters

Constituent Encoder
An FECAPI encoder object child of the generic_encoder class.
MTU (bytes)
The Maximum Transmission Unit (MTU) of the input frame that the block will be able to process. Specified in bytes and defaults to 1500.
Length Tag Name
Key name of the tagged stream frame size.

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.

Source Files

C++ files
[1]
Header files
[2]
Public header files
[3]
Block definition
[4]