<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.17.0" xml:lang="en-US">
  <compounddef id="classgr_1_1fec_1_1generic__decoder" kind="class" language="C++" prot="public" abstract="yes">
    <compoundname>gr::fec::generic_decoder</compoundname>
    <derivedcompoundref refid="classgr_1_1fec_1_1code_1_1cc__decoder" prot="public" virt="virtual">gr::fec::code::cc_decoder</derivedcompoundref>
    <derivedcompoundref refid="classgr_1_1fec_1_1code_1_1dummy__decoder" prot="public" virt="virtual">gr::fec::code::dummy_decoder</derivedcompoundref>
    <derivedcompoundref refid="classgr_1_1fec_1_1code_1_1ldpc__bit__flip__decoder" prot="public" virt="virtual">gr::fec::code::ldpc_bit_flip_decoder</derivedcompoundref>
    <derivedcompoundref refid="classgr_1_1fec_1_1code_1_1polar__decoder__common" prot="public" virt="non-virtual">gr::fec::code::polar_decoder_common</derivedcompoundref>
    <derivedcompoundref refid="classgr_1_1fec_1_1code_1_1repetition__decoder" prot="public" virt="virtual">gr::fec::code::repetition_decoder</derivedcompoundref>
    <derivedcompoundref refid="classgr_1_1fec_1_1ldpc__decoder" prot="public" virt="non-virtual">gr::fec::ldpc_decoder</derivedcompoundref>
    <derivedcompoundref refid="classgr_1_1fec_1_1tpc__decoder" prot="public" virt="non-virtual">gr::fec::tpc_decoder</derivedcompoundref>
    <includes refid="generic__decoder_8h" local="no">gnuradio/fec/generic_decoder.h</includes>
    <sectiondef kind="public-type">
      <memberdef kind="typedef" id="classgr_1_1fec_1_1generic__decoder_1a8536c9bc3f1ba576bb1245f1040b32ae" prot="public" static="no">
        <type>std::shared_ptr&lt; <ref refid="classgr_1_1fec_1_1generic__decoder_1a699ddfa2fc51343b3193149646bab208" kindref="member">generic_decoder</ref> &gt;</type>
        <definition>typedef std::shared_ptr&lt;generic_decoder&gt; gr::fec::generic_decoder::sptr</definition>
        <argsstring></argsstring>
        <name>sptr</name>
        <qualifiedname>gr::fec::generic_decoder::sptr</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="62" column="29" bodyfile="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" bodystart="62" bodyend="-1"/>
      </memberdef>
    </sectiondef>
    <sectiondef kind="protected-attrib">
      <memberdef kind="variable" id="classgr_1_1fec_1_1generic__decoder_1a29d043afec8a523972c67e17bf8f3f78" prot="protected" static="no" mutable="no">
        <type><ref refid="namespacegr_1a5f54bf3c08623ce6dea7b1cdb2eeada7" kindref="member">gr::logger_ptr</ref></type>
        <definition>gr::logger_ptr gr::fec::generic_decoder::d_logger</definition>
        <argsstring></argsstring>
        <name>d_logger</name>
        <qualifiedname>gr::fec::generic_decoder::d_logger</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="50" column="20" bodyfile="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" bodystart="50" bodyend="-1"/>
      </memberdef>
    </sectiondef>
    <sectiondef kind="friend">
      <memberdef kind="friend" id="classgr_1_1fec_1_1generic__decoder_1af38ba3228d4d04d31414fb1739ee7b34" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>class</type>
        <definition>friend class decoder</definition>
        <argsstring></argsstring>
        <name>decoder</name>
        <qualifiedname>gr::fec::generic_decoder::decoder</qualifiedname>
        <param>
          <type>decoder</type>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="53" column="18" bodyfile="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" bodystart="53" bodyend="-1"/>
        <references refid="classgr_1_1fec_1_1generic__decoder_1af38ba3228d4d04d31414fb1739ee7b34" compoundref="generic__decoder_8h" startline="53">decoder</references>
        <referencedby refid="classgr_1_1fec_1_1generic__decoder_1af38ba3228d4d04d31414fb1739ee7b34" compoundref="generic__decoder_8h" startline="53">decoder</referencedby>
      </memberdef>
    </sectiondef>
    <sectiondef kind="public-static-attrib">
      <memberdef kind="variable" id="classgr_1_1fec_1_1generic__decoder_1a09d4e84d633630b77a47b80398c209ad" prot="public" static="yes" mutable="no">
        <type>int</type>
        <definition>int gr::fec::generic_decoder::base_unique_id</definition>
        <argsstring></argsstring>
        <name>base_unique_id</name>
        <qualifiedname>gr::fec::generic_decoder::base_unique_id</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="55" column="16" bodyfile="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" bodystart="55" bodyend="-1"/>
      </memberdef>
    </sectiondef>
    <sectiondef kind="public-attrib">
      <memberdef kind="variable" id="classgr_1_1fec_1_1generic__decoder_1a2ea0d9d63a13ef1bd22e6517a856b340" prot="public" static="no" mutable="no">
        <type>int</type>
        <definition>int gr::fec::generic_decoder::my_id</definition>
        <argsstring></argsstring>
        <name>my_id</name>
        <qualifiedname>gr::fec::generic_decoder::my_id</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="56" column="9" bodyfile="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" bodystart="56" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr_1_1fec_1_1generic__decoder_1a96ed2f7bb7465e0df29a13b127ad9fd4" prot="public" static="no" mutable="no">
        <type>std::string</type>
        <definition>std::string gr::fec::generic_decoder::d_name</definition>
        <argsstring></argsstring>
        <name>d_name</name>
        <qualifiedname>gr::fec::generic_decoder::d_name</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="58" column="17" bodyfile="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" bodystart="58" bodyend="-1"/>
        <referencedby refid="classgr_1_1fec_1_1generic__decoder_1a9a6cbe6022c593cded3c00b929873855" compoundref="generic__decoder_8h" startline="59" endline="59">alias</referencedby>
      </memberdef>
    </sectiondef>
    <sectiondef kind="public-func">
      <memberdef kind="function" id="classgr_1_1fec_1_1generic__decoder_1a63079cebc08c5a13add64b5f24750e21" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>void</type>
        <definition>virtual void gr::fec::generic_decoder::generic_work</definition>
        <argsstring>(const void *inbuffer, void *outbuffer)=0</argsstring>
        <name>generic_work</name>
        <qualifiedname>gr::fec::generic_decoder::generic_work</qualifiedname>
        <reimplementedby refid="classgr_1_1fec_1_1code_1_1polar__decoder__sc_1a228b8ed46d5334bd6c3dc30e0e0377f4">generic_work</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1code_1_1polar__decoder__sc__list_1a452cc54e6957f717593a287f0333c1af">generic_work</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1code_1_1polar__decoder__sc__systematic_1ae1f8c1c9fe58b51412680c3a852c2fcf">generic_work</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1ldpc__decoder_1a8d035d777a397337d1a5d81ce4dd9274">generic_work</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1tpc__decoder_1a40a3b3983a8e4ac0a6b2292a2e760f8c">generic_work</reimplementedby>
        <param>
          <type>const void *</type>
          <declname>inbuffer</declname>
        </param>
        <param>
          <type>void *</type>
          <declname>outbuffer</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="54" column="18"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fec_1_1generic__decoder_1a7480b06afbc530f4a524905deab8f70b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>int</type>
        <definition>int gr::fec::generic_decoder::unique_id</definition>
        <argsstring>()</argsstring>
        <name>unique_id</name>
        <qualifiedname>gr::fec::generic_decoder::unique_id</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="57" column="9"/>
        <referencedby refid="classgr_1_1fec_1_1generic__decoder_1a9a6cbe6022c593cded3c00b929873855" compoundref="generic__decoder_8h" startline="59" endline="59">alias</referencedby>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fec_1_1generic__decoder_1a9a6cbe6022c593cded3c00b929873855" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>std::string</type>
        <definition>std::string gr::fec::generic_decoder::alias</definition>
        <argsstring>()</argsstring>
        <name>alias</name>
        <qualifiedname>gr::fec::generic_decoder::alias</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="59" column="17" bodyfile="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" bodystart="59" bodyend="59"/>
        <references refid="classgr_1_1fec_1_1generic__decoder_1a96ed2f7bb7465e0df29a13b127ad9fd4" compoundref="generic__decoder_8h" startline="58">d_name</references>
        <references refid="classgr_1_1fec_1_1generic__decoder_1a7480b06afbc530f4a524905deab8f70b">unique_id</references>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fec_1_1generic__decoder_1a699ddfa2fc51343b3193149646bab208" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>gr::fec::generic_decoder::generic_decoder</definition>
        <argsstring>(void)</argsstring>
        <name>generic_decoder</name>
        <qualifiedname>gr::fec::generic_decoder::generic_decoder</qualifiedname>
        <param>
          <type>void</type>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="64" column="5" bodyfile="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" bodystart="64" bodyend="64"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fec_1_1generic__decoder_1ab32bf0b94adb801b523001de32ee7dfc" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>gr::fec::generic_decoder::generic_decoder</definition>
        <argsstring>(std::string name)</argsstring>
        <name>generic_decoder</name>
        <qualifiedname>gr::fec::generic_decoder::generic_decoder</qualifiedname>
        <param>
          <type>std::string</type>
          <declname>name</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="65" column="5"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fec_1_1generic__decoder_1a36a7aeb512d578e53d6f984bfd380667" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type></type>
        <definition>virtual gr::fec::generic_decoder::~generic_decoder</definition>
        <argsstring>()</argsstring>
        <name>~generic_decoder</name>
        <qualifiedname>gr::fec::generic_decoder::~generic_decoder</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="66" column="13"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fec_1_1generic__decoder_1a32869de99deaec078e6b3bdc01444795" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>double</type>
        <definition>virtual double gr::fec::generic_decoder::rate</definition>
        <argsstring>()=0</argsstring>
        <name>rate</name>
        <qualifiedname>gr::fec::generic_decoder::rate</qualifiedname>
        <reimplementedby refid="classgr_1_1fec_1_1code_1_1cc__decoder_1a8c9f4f6267ac9cbce956a0f124bfb726">rate</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1code_1_1dummy__decoder_1af71edf349308441ef719ca78803938c1">rate</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1code_1_1ldpc__bit__flip__decoder_1a87a93518e9eb8f9d64ba6dda5c81d174">rate</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1code_1_1polar__decoder__common_1a6744b7e5516575041dc61be5a8ddf37d">rate</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1code_1_1repetition__decoder_1a0fe304e305afb4fd7ef6c4b654f55850">rate</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1ldpc__decoder_1a7ee5ef4fc4b2b55cf47c134dfb348239">rate</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1tpc__decoder_1ac71a3fe1b3074d0392bbf0ae025cd713">rate</reimplementedby>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Returns the rate of the code. For every r input bits, there is 1 output bit, so the rate is 1/r. Used for setting things like the encoder block&apos;s relative rate.</para>
<para>This function MUST be reimplemented by the child class. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="75" column="20"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fec_1_1generic__decoder_1a68f0c06cc9b57e421d4d755fc7eb60d5" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>int</type>
        <definition>virtual int gr::fec::generic_decoder::get_input_size</definition>
        <argsstring>()=0</argsstring>
        <name>get_input_size</name>
        <qualifiedname>gr::fec::generic_decoder::get_input_size</qualifiedname>
        <reimplementedby refid="classgr_1_1fec_1_1code_1_1polar__decoder__common_1a09360a2d9142ae873fdc1213982eb430">get_input_size</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1ldpc__decoder_1ae6d24f28ddc28517d76ee6d7cc04241b">get_input_size</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1tpc__decoder_1a50b112de1f8bd9fc842386ade262c838">get_input_size</reimplementedby>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Returns the input size in items that the decoder object uses to decode a full frame. Often, this number is the number of bits per frame if the input format is unpacked. If the block expects packed bytes, then this value should be the number of bytes (number of bits / 8) per input frame.</para>
<para>The child class MUST implement this function. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="86" column="17"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fec_1_1generic__decoder_1a0cad8d8b1977ebb9184b6c36ed73db9a" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>int</type>
        <definition>virtual int gr::fec::generic_decoder::get_output_size</definition>
        <argsstring>()=0</argsstring>
        <name>get_output_size</name>
        <qualifiedname>gr::fec::generic_decoder::get_output_size</qualifiedname>
        <reimplementedby refid="classgr_1_1fec_1_1code_1_1polar__decoder__common_1a6fda29bbc8181ef3ed25b7ef83d68b71">get_output_size</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1ldpc__decoder_1af4fdbea181019979788c2b9085500874">get_output_size</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1tpc__decoder_1a7902fcc80ed82d3f76158224ae4d963b">get_output_size</reimplementedby>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Returns the output size in items that the decoder object produces after decoding a full frame. Often, this number is the number of bits in the outputted frame if the input format is unpacked. If the block produces packed bytes, then this value should be the number of bytes (number of bits / 8) per frame produced. This value is generally something like <ref refid="classgr_1_1fec_1_1generic__decoder_1a68f0c06cc9b57e421d4d755fc7eb60d5" kindref="member">get_input_size()</ref>/R for a 1/R rate code.</para>
<para>The child class MUST implement this function. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="99" column="17"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fec_1_1generic__decoder_1a9037426d33b865dda50055380f9b85c8" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>int</type>
        <definition>virtual int gr::fec::generic_decoder::get_history</definition>
        <argsstring>()</argsstring>
        <name>get_history</name>
        <qualifiedname>gr::fec::generic_decoder::get_history</qualifiedname>
        <reimplementedby refid="classgr_1_1fec_1_1ldpc__decoder_1a8ad842b5bba722d8418d6d6f649580f0">get_history</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1tpc__decoder_1a10963e650f2ff7674c50316bffe3108d">get_history</reimplementedby>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Sets up history for the decoder when the decoder is required to look ahead in the data stream in order to finish its processing.</para>
<para>The child class MAY implement this function. If not reimplemented, it returns 0. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="109" column="17"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fec_1_1generic__decoder_1a7c46fd20d994c05ece2aa93dc8d3a926" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>float</type>
        <definition>virtual float gr::fec::generic_decoder::get_shift</definition>
        <argsstring>()</argsstring>
        <name>get_shift</name>
        <qualifiedname>gr::fec::generic_decoder::get_shift</qualifiedname>
        <reimplementedby refid="classgr_1_1fec_1_1ldpc__decoder_1afdf13a163e0ac42af267a89d732935d2">get_shift</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1tpc__decoder_1a584847ffd4fffbf5a605a2196c5ec68a">get_shift</reimplementedby>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Some decoders require the input items to float around a particular soft value. We can set that floating value by setting this value to return some non-zero number.</para>
<para>The fec.extended_decoder block will use this to create an add_const_ff block before the decoder block to adjust all input samples appropriately.</para>
<para>The child class MAY implement this function. If not reimplemented, it returns 0. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="123" column="19"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fec_1_1generic__decoder_1a1f4ba1fe5a0e9b3508724b48400ff537" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>int</type>
        <definition>virtual int gr::fec::generic_decoder::get_input_item_size</definition>
        <argsstring>()</argsstring>
        <name>get_input_item_size</name>
        <qualifiedname>gr::fec::generic_decoder::get_input_item_size</qualifiedname>
        <reimplementedby refid="classgr_1_1fec_1_1ldpc__decoder_1aa7c6563367f2eed585fa843a9b21ef2b">get_input_item_size</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1tpc__decoder_1a40a8344b35d77152fa9bd2bc64153d45">get_input_item_size</reimplementedby>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Sets the size of an input item, as in the size of a char or float item.</para>
<para>The child class SHOULD implement this function. If not reimplemented, it returns sizeof(float) as the decoders typically expect floating point input types. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="133" column="17"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fec_1_1generic__decoder_1a558263fff172b7867ed96afccb93078f" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>int</type>
        <definition>virtual int gr::fec::generic_decoder::get_output_item_size</definition>
        <argsstring>()</argsstring>
        <name>get_output_item_size</name>
        <qualifiedname>gr::fec::generic_decoder::get_output_item_size</qualifiedname>
        <reimplementedby refid="classgr_1_1fec_1_1ldpc__decoder_1ae1766f1d873e4c67b24d3d7a8bd4ef66">get_output_item_size</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1tpc__decoder_1a137b2055a812fb9dadd6a48ce6711fcb">get_output_item_size</reimplementedby>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Sets the size of an output item, as in the size of a char or float item.</para>
<para>The child class SHOULD implement this function. If not reimplemented, it returns sizeof(char) as the decoders typically expect to produce bits or bytes. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="143" column="17"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fec_1_1generic__decoder_1a0da070002d16590ec2f1277431ba2afb" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>const char *</type>
        <definition>virtual const char * gr::fec::generic_decoder::get_input_conversion</definition>
        <argsstring>()</argsstring>
        <name>get_input_conversion</name>
        <qualifiedname>gr::fec::generic_decoder::get_input_conversion</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Set up a conversion type required to setup the data properly for this decoder. The decoder itself will not implement the conversion and expects an external wrapper (e.g., fec.extended_decoder) to read this value and &quot;do the right
thing&quot; to format the data.</para>
<para>The default behavior is &apos;none&apos;, which means no conversion is required. Whatever the <ref refid="classgr_1_1fec_1_1generic__decoder_1a1f4ba1fe5a0e9b3508724b48400ff537" kindref="member">get_input_item_size()</ref> value returns, the input is expected to conform directly to this.</para>
<para>This may also return &apos;uchar&apos;, which indicates that the wrapper should convert the standard float samples to unsigned characters, either hard sliced or 8-bit soft symbols. See <ref refid="classgr_1_1fec_1_1code_1_1cc__decoder" kindref="compound">gr::fec::code::cc_decoder</ref> as an example decoder that uses this conversion format.</para>
<para>If &apos;packed_bits&apos;, the block expects the inputs to be packed hard bits. Each input item is a unsigned char where each of the 8-bits is a hard bit value.</para>
<para>The child class SHOULD implement this function. If not reimplemented, it returns &quot;none&quot;. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="169" column="24"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fec_1_1generic__decoder_1ae42dd367cb736e35ea3058536597d559" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>const char *</type>
        <definition>virtual const char * gr::fec::generic_decoder::get_output_conversion</definition>
        <argsstring>()</argsstring>
        <name>get_output_conversion</name>
        <qualifiedname>gr::fec::generic_decoder::get_output_conversion</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Set up a conversion type required to understand the output style of this decoder. Generally, follow-on processing expects unpacked bits, so we specify the conversion type here to indicate what the wrapper (e.g., fec.extended_decoder) should do to convert the output samples from the decoder into unpacked bits.</para>
<para>The default behavior is &apos;none&apos;, which means no conversion is required. This should mean that the output data is produced from this decoder as unpacked bit.</para>
<para>If &apos;unpack&apos;, the block produces packed bytes that should be unpacked by the wrapper. See gr::fec::code::ccsds_decoder as an example of a decoder that produces packed bytes.</para>
<para>The child class SHOULD implement this function. If not reimplemented, it returns &quot;none&quot;. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="190" column="24"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fec_1_1generic__decoder_1a6da8f43baf97fab0691e80355f2fbb74" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>bool</type>
        <definition>virtual bool gr::fec::generic_decoder::set_frame_size</definition>
        <argsstring>(unsigned int frame_size)=0</argsstring>
        <name>set_frame_size</name>
        <qualifiedname>gr::fec::generic_decoder::set_frame_size</qualifiedname>
        <reimplementedby refid="classgr_1_1fec_1_1code_1_1cc__decoder_1a77f7499ffbd8d2697412c3f8fd2589c1">set_frame_size</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1code_1_1dummy__decoder_1ac93c2447283d8bbb33c544c0b67e0df7">set_frame_size</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1code_1_1ldpc__bit__flip__decoder_1ac90417828eb6cf94ecf7cab6dcb99d27">set_frame_size</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1code_1_1polar__decoder__common_1a054ba1fa99f3f1b57c6877dbdd366cb1">set_frame_size</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1code_1_1repetition__decoder_1a042846a8862b8f5e72a1af9239764185">set_frame_size</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1ldpc__decoder_1a84f01114335ba0140cf27a8cffd2708a">set_frame_size</reimplementedby>
        <reimplementedby refid="classgr_1_1fec_1_1tpc__decoder_1aca09e08b4de0292cf5156c24970c91c1">set_frame_size</reimplementedby>
        <param>
          <type>unsigned int</type>
          <declname>frame_size</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Updates the size of a decoded frame.</para>
<para>The child class MUST implement this function and interpret how the <computeroutput>frame_size</computeroutput> information affects the block&apos;s behavior. It should also provide bounds checks. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="199" column="18"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fec_1_1generic__decoder_1a75ffb122f2891ee457be1874e198e836" prot="public" static="no" const="no" explicit="no" inline="yes" virt="virtual">
        <type>float</type>
        <definition>virtual float gr::fec::generic_decoder::get_iterations</definition>
        <argsstring>()</argsstring>
        <name>get_iterations</name>
        <qualifiedname>gr::fec::generic_decoder::get_iterations</qualifiedname>
        <reimplementedby refid="classgr_1_1fec_1_1ldpc__decoder_1aadb1fc9a60eae743b745b920b59ae77c">get_iterations</reimplementedby>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Get repetitions to decode.</para>
<para>The child class should implement this function and return the number of iterations required to decode. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="208" column="19" bodyfile="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" bodystart="208" bodyend="208"/>
      </memberdef>
    </sectiondef>
    <briefdescription>
<para>Parent class for FECAPI objects. </para>
    </briefdescription>
    <detaileddescription>
<para>Parent of a decoder variable class for FECAPI that will fit into the <ref refid="classgr_1_1fec_1_1decoder" kindref="compound">gr::fec::decoder</ref> block to handle FEC decoding. This class provides the basic information required to fit into the FECAPI structure. It provides information about input and output data types, potential data conversions, and a few other parameters useful to establish the decoder&apos;s behavior.</para>
<para>We create objects from FECAPI-derived classes to go into the actual GNU Radio decoder block. Each object contains its own state and so there should be a one-to-one mapping of an FECAPI object and a GR decoder block. Sharing these objects is not guaranteed to be thread-safe.</para>
<para>This is a pure virtual class and must be derived from by a child class.</para>
<para><simplesect kind="see"><para><ref refid="classgr_1_1fec_1_1code_1_1cc__decoder" kindref="compound">gr::fec::code::cc_decoder</ref> </para>
</simplesect>
<simplesect kind="see"><para>gr::fec::code::ccsds_decoder </para>
</simplesect>
</para>
    </detaileddescription>
    <inheritancegraph>
      <node id="2">
        <label>gr::fec::code::cc_decoder</label>
        <link refid="classgr_1_1fec_1_1code_1_1cc__decoder"/>
        <childnode refid="1" relation="public-inheritance">
        </childnode>
      </node>
      <node id="3">
        <label>gr::fec::code::dummy_decoder</label>
        <link refid="classgr_1_1fec_1_1code_1_1dummy__decoder"/>
        <childnode refid="1" relation="public-inheritance">
        </childnode>
      </node>
      <node id="4">
        <label>gr::fec::code::ldpc_bit_flip_decoder</label>
        <link refid="classgr_1_1fec_1_1code_1_1ldpc__bit__flip__decoder"/>
        <childnode refid="1" relation="public-inheritance">
        </childnode>
      </node>
      <node id="5">
        <label>gr::fec::code::polar_decoder_common</label>
        <link refid="classgr_1_1fec_1_1code_1_1polar__decoder__common"/>
        <childnode refid="1" relation="public-inheritance">
        </childnode>
      </node>
      <node id="6">
        <label>gr::fec::code::polar_decoder_sc</label>
        <link refid="classgr_1_1fec_1_1code_1_1polar__decoder__sc"/>
        <childnode refid="5" relation="public-inheritance">
        </childnode>
      </node>
      <node id="7">
        <label>gr::fec::code::polar_decoder_sc_list</label>
        <link refid="classgr_1_1fec_1_1code_1_1polar__decoder__sc__list"/>
        <childnode refid="5" relation="public-inheritance">
        </childnode>
      </node>
      <node id="8">
        <label>gr::fec::code::polar_decoder_sc_systematic</label>
        <link refid="classgr_1_1fec_1_1code_1_1polar__decoder__sc__systematic"/>
        <childnode refid="5" relation="public-inheritance">
        </childnode>
      </node>
      <node id="9">
        <label>gr::fec::code::repetition_decoder</label>
        <link refid="classgr_1_1fec_1_1code_1_1repetition__decoder"/>
        <childnode refid="1" relation="public-inheritance">
        </childnode>
      </node>
      <node id="1">
        <label>gr::fec::generic_decoder</label>
        <link refid="classgr_1_1fec_1_1generic__decoder"/>
      </node>
      <node id="10">
        <label>gr::fec::ldpc_decoder</label>
        <link refid="classgr_1_1fec_1_1ldpc__decoder"/>
        <childnode refid="1" relation="public-inheritance">
        </childnode>
      </node>
      <node id="11">
        <label>gr::fec::tpc_decoder</label>
        <link refid="classgr_1_1fec_1_1tpc__decoder"/>
        <childnode refid="1" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="1">
        <label>gr::fec::generic_decoder</label>
        <link refid="classgr_1_1fec_1_1generic__decoder"/>
        <childnode refid="2" relation="usage">
          <edgelabel>d_logger</edgelabel>
        </childnode>
        <childnode refid="3" relation="usage">
          <edgelabel>d_name</edgelabel>
        </childnode>
      </node>
      <node id="4">
        <label>std::basic_string&lt; Char &gt;</label>
      </node>
      <node id="2">
        <label>std::shared_ptr&lt; logger &gt;</label>
      </node>
      <node id="3">
        <label>std::string</label>
        <childnode refid="4" relation="public-inheritance">
        </childnode>
      </node>
    </collaborationgraph>
    <location file="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" line="47" column="1" bodyfile="/pbulk/work/ham/gnuradio-doxygen/work/gnuradio-3.10.12.0/gr-fec/include/gnuradio/fec/generic_decoder.h" bodystart="48" bodyend="209"/>
    <listofallmembers>
      <member refid="classgr_1_1fec_1_1generic__decoder_1a9a6cbe6022c593cded3c00b929873855" prot="public" virt="non-virtual"><scope>gr::fec::generic_decoder</scope><name>alias</name></member>
      <member refid="classgr_1_1fec_1_1generic__decoder_1a09d4e84d633630b77a47b80398c209ad" prot="public" virt="non-virtual"><scope>gr::fec::generic_decoder</scope><name>base_unique_id</name></member>
      <member refid="classgr_1_1fec_1_1generic__decoder_1a29d043afec8a523972c67e17bf8f3f78" prot="protected" virt="non-virtual"><scope>gr::fec::generic_decoder</scope><name>d_logger</name></member>
      <member refid="classgr_1_1fec_1_1generic__decoder_1a96ed2f7bb7465e0df29a13b127ad9fd4" prot="public" virt="non-virtual"><scope>gr::fec::generic_decoder</scope><name>d_name</name></member>
      <member refid="classgr_1_1fec_1_1generic__decoder_1af38ba3228d4d04d31414fb1739ee7b34" prot="public" virt="non-virtual"><scope>gr::fec::generic_decoder</scope><name>decoder</name></member>
      <member refid="classgr_1_1fec_1_1generic__decoder_1a699ddfa2fc51343b3193149646bab208" prot="public" virt="non-virtual"><scope>gr::fec::generic_decoder</scope><name>generic_decoder</name></member>
      <member refid="classgr_1_1fec_1_1generic__decoder_1ab32bf0b94adb801b523001de32ee7dfc" prot="public" virt="non-virtual"><scope>gr::fec::generic_decoder</scope><name>generic_decoder</name></member>
      <member refid="classgr_1_1fec_1_1generic__decoder_1a63079cebc08c5a13add64b5f24750e21" prot="public" virt="pure-virtual"><scope>gr::fec::generic_decoder</scope><name>generic_work</name></member>
      <member refid="classgr_1_1fec_1_1generic__decoder_1a9037426d33b865dda50055380f9b85c8" prot="public" virt="virtual"><scope>gr::fec::generic_decoder</scope><name>get_history</name></member>
      <member refid="classgr_1_1fec_1_1generic__decoder_1a0da070002d16590ec2f1277431ba2afb" prot="public" virt="virtual"><scope>gr::fec::generic_decoder</scope><name>get_input_conversion</name></member>
      <member refid="classgr_1_1fec_1_1generic__decoder_1a1f4ba1fe5a0e9b3508724b48400ff537" prot="public" virt="virtual"><scope>gr::fec::generic_decoder</scope><name>get_input_item_size</name></member>
      <member refid="classgr_1_1fec_1_1generic__decoder_1a68f0c06cc9b57e421d4d755fc7eb60d5" prot="public" virt="pure-virtual"><scope>gr::fec::generic_decoder</scope><name>get_input_size</name></member>
      <member refid="classgr_1_1fec_1_1generic__decoder_1a75ffb122f2891ee457be1874e198e836" prot="public" virt="virtual"><scope>gr::fec::generic_decoder</scope><name>get_iterations</name></member>
      <member refid="classgr_1_1fec_1_1generic__decoder_1ae42dd367cb736e35ea3058536597d559" prot="public" virt="virtual"><scope>gr::fec::generic_decoder</scope><name>get_output_conversion</name></member>
      <member refid="classgr_1_1fec_1_1generic__decoder_1a558263fff172b7867ed96afccb93078f" prot="public" virt="virtual"><scope>gr::fec::generic_decoder</scope><name>get_output_item_size</name></member>
      <member refid="classgr_1_1fec_1_1generic__decoder_1a0cad8d8b1977ebb9184b6c36ed73db9a" prot="public" virt="pure-virtual"><scope>gr::fec::generic_decoder</scope><name>get_output_size</name></member>
      <member refid="classgr_1_1fec_1_1generic__decoder_1a7c46fd20d994c05ece2aa93dc8d3a926" prot="public" virt="virtual"><scope>gr::fec::generic_decoder</scope><name>get_shift</name></member>
      <member refid="classgr_1_1fec_1_1generic__decoder_1a2ea0d9d63a13ef1bd22e6517a856b340" prot="public" virt="non-virtual"><scope>gr::fec::generic_decoder</scope><name>my_id</name></member>
      <member refid="classgr_1_1fec_1_1generic__decoder_1a32869de99deaec078e6b3bdc01444795" prot="public" virt="pure-virtual"><scope>gr::fec::generic_decoder</scope><name>rate</name></member>
      <member refid="classgr_1_1fec_1_1generic__decoder_1a6da8f43baf97fab0691e80355f2fbb74" prot="public" virt="pure-virtual"><scope>gr::fec::generic_decoder</scope><name>set_frame_size</name></member>
      <member refid="classgr_1_1fec_1_1generic__decoder_1a8536c9bc3f1ba576bb1245f1040b32ae" prot="public" virt="non-virtual"><scope>gr::fec::generic_decoder</scope><name>sptr</name></member>
      <member refid="classgr_1_1fec_1_1generic__decoder_1a7480b06afbc530f4a524905deab8f70b" prot="public" virt="non-virtual"><scope>gr::fec::generic_decoder</scope><name>unique_id</name></member>
      <member refid="classgr_1_1fec_1_1generic__decoder_1a36a7aeb512d578e53d6f984bfd380667" prot="public" virt="virtual"><scope>gr::fec::generic_decoder</scope><name>~generic_decoder</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
