<?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.14.0" xml:lang="en-US">
  <compounddef id="classgr_1_1satellites_1_1crc__append" kind="class" language="C++" prot="public">
    <compoundname>gr::satellites::crc_append</compoundname>
    <basecompoundref prot="public" virt="virtual">gr::block</basecompoundref>
    <derivedcompoundref refid="classgr_1_1satellites_1_1crc__append__impl" prot="public" virt="non-virtual">gr::satellites::crc_append_impl</derivedcompoundref>
    <includes refid="crc__append_8h" local="no">crc_append.h</includes>
    <sectiondef kind="public-type">
      <memberdef kind="typedef" id="classgr_1_1satellites_1_1crc__append_1a248901f3826756a86f106c284daad773" prot="public" static="no">
        <type>boost::shared_ptr&lt; <ref refid="classgr_1_1satellites_1_1crc__append" kindref="compound">crc_append</ref> &gt;</type>
        <definition>typedef boost::shared_ptr&lt;crc_append&gt; gr::satellites::crc_append::sptr</definition>
        <argsstring></argsstring>
        <name>sptr</name>
        <qualifiedname>gr::satellites::crc_append::sptr</qualifiedname>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/opt/local/var/macports/build/gr-satellites-4c327f95/work/gr-satellites-3.16.0/include/satellites/crc_append.h" line="35" column="31" bodyfile="/opt/local/var/macports/build/gr-satellites-4c327f95/work/gr-satellites-3.16.0/include/satellites/crc_append.h" bodystart="35" bodyend="-1"/>
      </memberdef>
    </sectiondef>
    <sectiondef kind="public-static-func">
      <memberdef kind="function" id="classgr_1_1satellites_1_1crc__append_1adcdefcc36059a305eedaf26e39ed59db" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="classgr_1_1satellites_1_1crc__append_1a248901f3826756a86f106c284daad773" kindref="member">sptr</ref></type>
        <definition>static sptr gr::satellites::crc_append::make</definition>
        <argsstring>(unsigned num_bits, uint64_t poly, uint64_t initial_value, uint64_t final_xor, bool input_reflected, bool result_reflected, bool swap_endianness, unsigned skip_header_bytes=0)</argsstring>
        <name>make</name>
        <qualifiedname>gr::satellites::crc_append::make</qualifiedname>
        <param>
          <type>unsigned</type>
          <declname>num_bits</declname>
        </param>
        <param>
          <type>uint64_t</type>
          <declname>poly</declname>
        </param>
        <param>
          <type>uint64_t</type>
          <declname>initial_value</declname>
        </param>
        <param>
          <type>uint64_t</type>
          <declname>final_xor</declname>
        </param>
        <param>
          <type>bool</type>
          <declname>input_reflected</declname>
        </param>
        <param>
          <type>bool</type>
          <declname>result_reflected</declname>
        </param>
        <param>
          <type>bool</type>
          <declname>swap_endianness</declname>
        </param>
        <param>
          <type>unsigned</type>
          <declname>skip_header_bytes</declname>
          <defval>0</defval>
        </param>
        <briefdescription>
<para>Build the CRC append block. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>num_bits</parametername>
</parameternamelist>
<parameterdescription>
<para>CRC size in bits (must be a multiple of 8) </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>poly</parametername>
</parameternamelist>
<parameterdescription>
<para>CRC polynomial, in MSB-first notation </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>initial_value</parametername>
</parameternamelist>
<parameterdescription>
<para>Initial register value </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>final_xor</parametername>
</parameternamelist>
<parameterdescription>
<para>Final XOR value </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>input_reflected</parametername>
</parameternamelist>
<parameterdescription>
<para>true if the input is LSB-first, false if not </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>result_reflected</parametername>
</parameternamelist>
<parameterdescription>
<para>true if the output is LSB-first, false if not </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>swap_endianness</parametername>
</parameternamelist>
<parameterdescription>
<para>true if the CRC is stored as little-endian in the PDU, false if not </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>skip_header_bytes</parametername>
</parameternamelist>
<parameterdescription>
<para>gives the number of header byte to skip in the CRC calculation </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/opt/local/var/macports/build/gr-satellites-4c327f95/work/gr-satellites-3.16.0/include/satellites/crc_append.h" line="51" column="17"/>
      </memberdef>
    </sectiondef>
    <briefdescription>
<para>Calculates and appends a CRC to a PDU. </para>
    </briefdescription>
    <detaileddescription>
<para>The CRC append block receives a PDU, calculates the CRC of the PDU data, appends it to the PDU, and sends that as its output. It can support any CRC whose size is a multiple of 8 bits between 8 and 64 bits. </para>
    </detaileddescription>
    <inheritancegraph>
      <node id="2">
        <label>gr::block</label>
      </node>
      <node id="1">
        <label>gr::satellites::crc_append</label>
        <link refid="classgr_1_1satellites_1_1crc__append"/>
        <childnode refid="2" relation="public-inheritance">
        </childnode>
      </node>
      <node id="3">
        <label>gr::satellites::crc_append_impl</label>
        <link refid="classgr_1_1satellites_1_1crc__append__impl"/>
        <childnode refid="1" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="2">
        <label>gr::block</label>
      </node>
      <node id="1">
        <label>gr::satellites::crc_append</label>
        <link refid="classgr_1_1satellites_1_1crc__append"/>
        <childnode refid="2" relation="public-inheritance">
        </childnode>
      </node>
    </collaborationgraph>
    <location file="/opt/local/var/macports/build/gr-satellites-4c327f95/work/gr-satellites-3.16.0/include/satellites/crc_append.h" line="32" column="1" bodyfile="/opt/local/var/macports/build/gr-satellites-4c327f95/work/gr-satellites-3.16.0/include/satellites/crc_append.h" bodystart="33" bodyend="59"/>
    <listofallmembers>
      <member refid="classgr_1_1satellites_1_1crc__append_1adcdefcc36059a305eedaf26e39ed59db" prot="public" virt="non-virtual"><scope>gr::satellites::crc_append</scope><name>make</name></member>
      <member refid="classgr_1_1satellites_1_1crc__append_1a248901f3826756a86f106c284daad773" prot="public" virt="non-virtual"><scope>gr::satellites::crc_append</scope><name>sptr</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
