<?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__check" kind="class" language="C++" prot="public">
    <compoundname>gr::satellites::crc_check</compoundname>
    <basecompoundref prot="public" virt="virtual">gr::block</basecompoundref>
    <derivedcompoundref refid="classgr_1_1satellites_1_1crc__check__impl" prot="public" virt="non-virtual">gr::satellites::crc_check_impl</derivedcompoundref>
    <includes refid="crc__check_8h" local="no">crc_check.h</includes>
    <sectiondef kind="public-type">
      <memberdef kind="typedef" id="classgr_1_1satellites_1_1crc__check_1af8b077e3e33c32bbfd2c357400889b42" prot="public" static="no">
        <type>boost::shared_ptr&lt; <ref refid="classgr_1_1satellites_1_1crc__check" kindref="compound">crc_check</ref> &gt;</type>
        <definition>typedef boost::shared_ptr&lt;crc_check&gt; gr::satellites::crc_check::sptr</definition>
        <argsstring></argsstring>
        <name>sptr</name>
        <qualifiedname>gr::satellites::crc_check::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_check.h" line="36" column="31" bodyfile="/opt/local/var/macports/build/gr-satellites-4c327f95/work/gr-satellites-3.16.0/include/satellites/crc_check.h" bodystart="36" bodyend="-1"/>
      </memberdef>
    </sectiondef>
    <sectiondef kind="public-static-func">
      <memberdef kind="function" id="classgr_1_1satellites_1_1crc__check_1a2a1c40ec7ceaa70708f311cfd9b33cdc" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="classgr_1_1satellites_1_1crc__check_1af8b077e3e33c32bbfd2c357400889b42" kindref="member">sptr</ref></type>
        <definition>static sptr gr::satellites::crc_check::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, bool discard_crc=false, unsigned skip_header_bytes=0)</argsstring>
        <name>make</name>
        <qualifiedname>gr::satellites::crc_check::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>bool</type>
          <declname>discard_crc</declname>
          <defval>false</defval>
        </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>discard_crc</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, the CRC is removed from the PDU before sending it to the output port. If false, the CRC is preserved in the outupt PDU. </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_check.h" line="54" column="17"/>
      </memberdef>
    </sectiondef>
    <briefdescription>
<para>Check the CRC at the end of a PDU. </para>
    </briefdescription>
    <detaileddescription>
<para>The CRC append block receives a PDU containing a CRC at its end, and checks whether the CRC is correct. The PDU is sent over the ok or fail output ports according to the result of this check. 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_check</label>
        <link refid="classgr_1_1satellites_1_1crc__check"/>
        <childnode refid="2" relation="public-inheritance">
        </childnode>
      </node>
      <node id="3">
        <label>gr::satellites::crc_check_impl</label>
        <link refid="classgr_1_1satellites_1_1crc__check__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_check</label>
        <link refid="classgr_1_1satellites_1_1crc__check"/>
        <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_check.h" line="33" column="1" bodyfile="/opt/local/var/macports/build/gr-satellites-4c327f95/work/gr-satellites-3.16.0/include/satellites/crc_check.h" bodystart="34" bodyend="63"/>
    <listofallmembers>
      <member refid="classgr_1_1satellites_1_1crc__check_1a2a1c40ec7ceaa70708f311cfd9b33cdc" prot="public" virt="non-virtual"><scope>gr::satellites::crc_check</scope><name>make</name></member>
      <member refid="classgr_1_1satellites_1_1crc__check_1af8b077e3e33c32bbfd2c357400889b42" prot="public" virt="non-virtual"><scope>gr::satellites::crc_check</scope><name>sptr</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
