Difference between revisions of "CC Decoder Definition"

From GNU Radio
Jump to: navigation, 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...")
 
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
[[Category:Stub Docs]]
+
There currently seem to be no docs for this block.  If you know how to use this block, please fill out and improve this page.
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 ==
 +
 
 +
; Parallelism
 +
: TODO
 +
 
 +
; Frame Bits
 +
: TODO
 +
 
 +
; Constraint Length (K)
 +
: TODO
  
== Parameters ==
+
; Rate Inverse
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
+
: TODO
 +
 
 +
; Polynomials
 +
: TODO
 +
 
 +
; Start State
 +
: TODO
 +
 
 +
; End State
 +
: TODO
  
; Param 1 (''R'')
+
; Streaming Behavior
: 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).
+
: TODO
  
; Param 2
+
; Byte Padding
: blah blah blah
+
: TODO
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==
Line 21: Line 38:
  
 
; C++ files
 
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/lib/cc_decoder_impl.cc]
  
 
; Header files
 
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/lib/cc_decoder_impl.h]
  
 
; Public header files
 
; Public header files
Line 30: Line 47:
  
 
; Block definition
 
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/grc/variable_cc_decoder_def_list.block.yml]

Latest revision as of 04:08, 27 July 2019

There currently seem to be no docs for this block. If you know how to use this block, please fill out and improve this page.

Parameters[edit]

Parallelism
TODO
Frame Bits
TODO
Constraint Length (K)
TODO
Rate Inverse
TODO
Polynomials
TODO
Start State
TODO
End State
TODO
Streaming Behavior
TODO
Byte Padding
TODO

Example Flowgraph[edit]

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

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