Sophie

Sophie

distrib > Mandriva > 2010.2 > i586 > media > contrib-backports > by-pkgid > def0228095a1541e2d3632b6b6da7c38 > files > 8170

gnuradio-doc-3.3.0-8mdv2010.1.i586.rpm

<?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.6.3">
  <compounddef id="classatsci__trellis__encoder" kind="class" prot="public">
    <compoundname>atsci_trellis_encoder</compoundname>
    <includes refid="atsci__trellis__encoder_8h" local="no">atsci_trellis_encoder.h</includes>
      <sectiondef kind="public-static-attrib">
      <memberdef kind="variable" id="classatsci__trellis__encoder_1a03e72454b9a3e32233a862cae64a52a0" prot="public" static="yes" mutable="no">
        <type>const int</type>
        <definition>const int atsci_trellis_encoder::NCODERS</definition>
        <argsstring></argsstring>
        <name>NCODERS</name>
        <initializer> 12</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_trellis_encoder.h" line="35" bodyfile="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_trellis_encoder.h" bodystart="35" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="protected-static-attrib">
      <memberdef kind="variable" id="classatsci__trellis__encoder_1a3e2c569d172cf231dcc0c7e744a585d7" prot="protected" static="yes" mutable="no">
        <type>const int</type>
        <definition>const int atsci_trellis_encoder::SEGMENT_SIZE</definition>
        <argsstring></argsstring>
        <name>SEGMENT_SIZE</name>
        <initializer> <ref refid="atsc__consts_8h_1a7c0eb90bde7d56f842375f332247c0a5" kindref="member">ATSC_MPEG_RS_ENCODED_LENGTH</ref></initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_trellis_encoder.h" line="54" bodyfile="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_trellis_encoder.h" bodystart="54" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classatsci__trellis__encoder_1a650db430d766ff15c2372f3c9fba62ca" prot="protected" static="yes" mutable="no">
        <type>const int</type>
        <definition>const int atsci_trellis_encoder::INPUT_SIZE</definition>
        <argsstring></argsstring>
        <name>INPUT_SIZE</name>
        <initializer> (<ref refid="classatsci__trellis__encoder_1a3e2c569d172cf231dcc0c7e744a585d7" kindref="member">SEGMENT_SIZE</ref> * 12)</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_trellis_encoder.h" line="55" bodyfile="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_trellis_encoder.h" bodystart="55" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classatsci__trellis__encoder_1afecf24b0711360dd6a939df9b90bf644" prot="protected" static="yes" mutable="no">
        <type>const int</type>
        <definition>const int atsci_trellis_encoder::OUTPUT_SIZE</definition>
        <argsstring></argsstring>
        <name>OUTPUT_SIZE</name>
        <initializer> (<ref refid="atsc__consts_8h_1a06eb585fe7990a888ac9accd568c5230" kindref="member">ATSC_DATA_SEGMENT_LENGTH</ref> * 12)</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_trellis_encoder.h" line="56" bodyfile="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_trellis_encoder.h" bodystart="56" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="protected-attrib">
      <memberdef kind="variable" id="classatsci__trellis__encoder_1a3984f5c41bb9051d2bcfe98fc80a5f00" prot="protected" static="no" mutable="no">
        <type><ref refid="classatsci__basic__trellis__encoder" kindref="compound">atsci_basic_trellis_encoder</ref></type>
        <definition>atsci_basic_trellis_encoder atsci_trellis_encoder::enc[NCODERS]</definition>
        <argsstring>[NCODERS]</argsstring>
        <name>enc</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_trellis_encoder.h" line="61" bodyfile="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_trellis_encoder.h" bodystart="61" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classatsci__trellis__encoder_1adcf15e465af8f6f43ad997caa772417b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>atsci_trellis_encoder::atsci_trellis_encoder</definition>
        <argsstring>()</argsstring>
        <name>atsci_trellis_encoder</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_trellis_encoder.h" line="37"/>
      </memberdef>
      <memberdef kind="function" id="classatsci__trellis__encoder_1a58c0b59f6a4d8dbb53ee65b7c5e0d3a6" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>atsci_trellis_encoder::~atsci_trellis_encoder</definition>
        <argsstring>()</argsstring>
        <name>~atsci_trellis_encoder</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_trellis_encoder.h" line="38"/>
      </memberdef>
      <memberdef kind="function" id="classatsci__trellis__encoder_1a9e5b98f4cbc2cbcfaa831cdaa7927555" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void atsci_trellis_encoder::reset</definition>
        <argsstring>()</argsstring>
        <name>reset</name>
        <briefdescription>
<para>reset all encoder states </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_trellis_encoder.h" line="41"/>
      </memberdef>
      <memberdef kind="function" id="classatsci__trellis__encoder_1a6084798d2aded2665174691e1de99157" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void atsci_trellis_encoder::encode</definition>
        <argsstring>(atsc_data_segment out[NCODERS], const atsc_mpeg_packet_rs_encoded in[NCODERS])</argsstring>
        <name>encode</name>
        <param>
          <type><ref refid="classatsc__data__segment" kindref="compound">atsc_data_segment</ref></type>
          <declname>out</declname>
          <array>[NCODERS]</array>
        </param>
        <param>
          <type>const <ref refid="classatsc__mpeg__packet__rs__encoded" kindref="compound">atsc_mpeg_packet_rs_encoded</ref></type>
          <declname>in</declname>
          <array>[NCODERS]</array>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Take 12 RS encoded, convolutionally interleaved segments and produce 12 trellis coded data segments. We work in groups of 12 because that&apos;s the smallest number of segments that composes a single full cycle of the encoder mux. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_trellis_encoder.h" line="50"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="protected-func">
      <memberdef kind="function" id="classatsci__trellis__encoder_1aedc38cba59a229549cdc274f13241d11" prot="protected" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void atsci_trellis_encoder::encode_helper</definition>
        <argsstring>(unsigned char out[OUTPUT_SIZE], const unsigned char in[INPUT_SIZE])</argsstring>
        <name>encode_helper</name>
        <param>
          <type>unsigned char</type>
          <declname>out</declname>
          <array>[OUTPUT_SIZE]</array>
        </param>
        <param>
          <type>const unsigned char</type>
          <declname>in</declname>
          <array>[INPUT_SIZE]</array>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_trellis_encoder.h" line="59"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>fancy, schmancy 12-way interleaved trellis encoder for ATSC </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <collaborationgraph>
      <node id="5875">
        <label>atsci_basic_trellis_encoder</label>
        <link refid="classatsci__basic__trellis__encoder"/>
      </node>
      <node id="5874">
        <label>atsci_trellis_encoder</label>
        <link refid="classatsci__trellis__encoder"/>
        <childnode refid="5875" relation="usage">
          <edgelabel>enc</edgelabel>
        </childnode>
      </node>
    </collaborationgraph>
    <location file="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_trellis_encoder.h" line="33" bodyfile="/home/mandrake/rpm/BUILD/gnuradio-3.3.0/gr-atsc/src/lib/atsci_trellis_encoder.h" bodystart="33" bodyend="63"/>
    <listofallmembers>
      <member refid="classatsci__trellis__encoder_1adcf15e465af8f6f43ad997caa772417b" prot="public" virt="non-virtual"><scope>atsci_trellis_encoder</scope><name>atsci_trellis_encoder</name></member>
      <member refid="classatsci__trellis__encoder_1a3984f5c41bb9051d2bcfe98fc80a5f00" prot="protected" virt="non-virtual"><scope>atsci_trellis_encoder</scope><name>enc</name></member>
      <member refid="classatsci__trellis__encoder_1a6084798d2aded2665174691e1de99157" prot="public" virt="non-virtual"><scope>atsci_trellis_encoder</scope><name>encode</name></member>
      <member refid="classatsci__trellis__encoder_1aedc38cba59a229549cdc274f13241d11" prot="protected" virt="non-virtual"><scope>atsci_trellis_encoder</scope><name>encode_helper</name></member>
      <member refid="classatsci__trellis__encoder_1a650db430d766ff15c2372f3c9fba62ca" prot="protected" virt="non-virtual"><scope>atsci_trellis_encoder</scope><name>INPUT_SIZE</name></member>
      <member refid="classatsci__trellis__encoder_1a03e72454b9a3e32233a862cae64a52a0" prot="public" virt="non-virtual"><scope>atsci_trellis_encoder</scope><name>NCODERS</name></member>
      <member refid="classatsci__trellis__encoder_1afecf24b0711360dd6a939df9b90bf644" prot="protected" virt="non-virtual"><scope>atsci_trellis_encoder</scope><name>OUTPUT_SIZE</name></member>
      <member refid="classatsci__trellis__encoder_1a9e5b98f4cbc2cbcfaa831cdaa7927555" prot="public" virt="non-virtual"><scope>atsci_trellis_encoder</scope><name>reset</name></member>
      <member refid="classatsci__trellis__encoder_1a3e2c569d172cf231dcc0c7e744a585d7" prot="protected" virt="non-virtual"><scope>atsci_trellis_encoder</scope><name>SEGMENT_SIZE</name></member>
      <member refid="classatsci__trellis__encoder_1a58c0b59f6a4d8dbb53ee65b7c5e0d3a6" prot="public" virt="non-virtual"><scope>atsci_trellis_encoder</scope><name>~atsci_trellis_encoder</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>