Sophie

Sophie

distrib > Mageia > 7 > i586 > media > core-release > by-pkgid > 324226fa09cfa21a5ddada93eab2fc83 > files > 110

gr-fcdproplus-doc-3.7.12-3.mga7.noarch.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.8.15">
  <compounddef id="classgr_1_1fcdproplus_1_1fcdproplus__impl" kind="class" language="C++" prot="public">
    <compoundname>gr::fcdproplus::fcdproplus_impl</compoundname>
    <basecompoundref refid="classgr_1_1fcdproplus_1_1fcdproplus" prot="public" virt="non-virtual">gr::fcdproplus::fcdproplus</basecompoundref>
    <includes refid="fcdproplus__impl_8h" local="no">fcdproplus_impl.h</includes>
      <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classgr_1_1fcdproplus_1_1fcdproplus__impl_1a0541a6aa5692ca2b26e121859a00598f" prot="private" static="no" mutable="no">
        <type>gr::audio::source::sptr</type>
        <definition>gr::audio::source::sptr gr::fcdproplus::fcdproplus_impl::fcd</definition>
        <argsstring></argsstring>
        <name>fcd</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>The audio input source </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/lib/fcdproplus_impl.h" line="40" column="1" bodyfile="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/lib/fcdproplus_impl.h" bodystart="40" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr_1_1fcdproplus_1_1fcdproplus__impl_1a3f46925aec26be17dfd06d31442bc03d" prot="private" static="no" mutable="no">
        <type>hid_device *</type>
        <definition>hid_device* gr::fcdproplus::fcdproplus_impl::d_control_handle</definition>
        <argsstring></argsstring>
        <name>d_control_handle</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>handle to control the device, set frequency, etc </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/lib/fcdproplus_impl.h" line="41" column="1" bodyfile="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/lib/fcdproplus_impl.h" bodystart="41" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr_1_1fcdproplus_1_1fcdproplus__impl_1abb7e2296b8a008cf471dda8232832106" prot="private" static="no" mutable="no">
        <type>unsigned int</type>
        <definition>unsigned int gr::fcdproplus::fcdproplus_impl::d_freq_req</definition>
        <argsstring></argsstring>
        <name>d_freq_req</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>The latest requested frequency in Khz </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/lib/fcdproplus_impl.h" line="42" column="1" bodyfile="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/lib/fcdproplus_impl.h" bodystart="42" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr_1_1fcdproplus_1_1fcdproplus__impl_1af15c47643eb14064656ac968929e2c47" prot="private" static="no" mutable="no">
        <type>unsigned char</type>
        <definition>unsigned char gr::fcdproplus::fcdproplus_impl::aucBuf[65]</definition>
        <argsstring>[65]</argsstring>
        <name>aucBuf</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>Buffers to read/write control messages to the dongle </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/lib/fcdproplus_impl.h" line="43" column="1" bodyfile="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/lib/fcdproplus_impl.h" bodystart="43" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr_1_1fcdproplus_1_1fcdproplus__impl_1a0abcaad14fce11cf1be3f9ba5ef46aaf" prot="private" static="no" mutable="no">
        <type>int</type>
        <definition>int gr::fcdproplus::fcdproplus_impl::d_corr</definition>
        <argsstring></argsstring>
        <name>d_corr</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/lib/fcdproplus_impl.h" line="44" column="1" bodyfile="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/lib/fcdproplus_impl.h" bodystart="44" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr_1_1fcdproplus_1_1fcdproplus__impl_1a35334c28876ad7803997eac3e38d4a2d" prot="private" static="no" mutable="no">
        <type>int</type>
        <definition>int gr::fcdproplus::fcdproplus_impl::d_unit</definition>
        <argsstring></argsstring>
        <name>d_unit</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/lib/fcdproplus_impl.h" line="45" column="1" bodyfile="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/lib/fcdproplus_impl.h" bodystart="45" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classgr_1_1fcdproplus_1_1fcdproplus__impl_1af5600a501a95ef3aa0cca33fcb22819d" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>gr::fcdproplus::fcdproplus_impl::fcdproplus_impl</definition>
        <argsstring>(const std::string user_device_name, int unit)</argsstring>
        <name>fcdproplus_impl</name>
        <param>
          <type>const std::string</type>
          <declname>user_device_name</declname>
        </param>
        <param>
          <type>int</type>
          <declname>unit</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/lib/fcdproplus_impl.h" line="49" column="1"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fcdproplus_1_1fcdproplus__impl_1a4830e2af49e2f1cd2f0b58903ff0fd69" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>gr::fcdproplus::fcdproplus_impl::~fcdproplus_impl</definition>
        <argsstring>()</argsstring>
        <name>~fcdproplus_impl</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/lib/fcdproplus_impl.h" line="50" column="1"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fcdproplus_1_1fcdproplus__impl_1a734fbbf5e52b2782012eb9c3cd76e51d" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>void</type>
        <definition>void gr::fcdproplus::fcdproplus_impl::set_freq</definition>
        <argsstring>(float freq)</argsstring>
        <name>set_freq</name>
        <reimplements refid="classgr_1_1fcdproplus_1_1fcdproplus_1a9da58f91e3c6ee69f380d2f4eb5c997a">set_freq</reimplements>
        <param>
          <type>float</type>
          <declname>freq</declname>
        </param>
        <briefdescription>
<para>Set frequency with resolution defined by unit. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>freq</parametername>
</parameternamelist>
<parameterdescription>
<para>The frequency in unit Hz</para>
</parameterdescription>
</parameteritem>
</parameterlist>
Sets the frequency of the Funcube Dongle with Hz or Khz resolution depending on the unit paramater ( 1: Hz , 1000 Khz ) applying the frequency correction set by <ref refid="classgr_1_1fcdproplus_1_1fcdproplus__impl_1a41415b4f9daf64e7a0d378e47f1c448b" kindref="member">set_freq_corr()</ref>. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/lib/fcdproplus_impl.h" line="52" column="1"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fcdproplus_1_1fcdproplus__impl_1a34dc8b14252bf76f729d379ec260d512" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>void</type>
        <definition>void gr::fcdproplus::fcdproplus_impl::set_lna</definition>
        <argsstring>(int gain)</argsstring>
        <name>set_lna</name>
        <reimplements refid="classgr_1_1fcdproplus_1_1fcdproplus_1a0b8e92206019aa63e68125d4a6705280">set_lna</reimplements>
        <param>
          <type>int</type>
          <declname>gain</declname>
        </param>
        <briefdescription>
<para>Switches the LNA on/off. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>gain</parametername>
</parameternamelist>
<parameterdescription>
<para>lna on/off. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/lib/fcdproplus_impl.h" line="53" column="1"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fcdproplus_1_1fcdproplus__impl_1ad491b9b81af03bb3893ce8ab004a41d3" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>void</type>
        <definition>void gr::fcdproplus::fcdproplus_impl::set_mixer_gain</definition>
        <argsstring>(int gain)</argsstring>
        <name>set_mixer_gain</name>
        <reimplements refid="classgr_1_1fcdproplus_1_1fcdproplus_1a4300449c9276498849c929f7e30189aa">set_mixer_gain</reimplements>
        <param>
          <type>int</type>
          <declname>gain</declname>
        </param>
        <briefdescription>
<para>Switches mixer gain onf/off. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>gain</parametername>
</parameternamelist>
<parameterdescription>
<para>true means on. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/lib/fcdproplus_impl.h" line="54" column="1"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fcdproplus_1_1fcdproplus__impl_1a41415b4f9daf64e7a0d378e47f1c448b" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>void</type>
        <definition>void gr::fcdproplus::fcdproplus_impl::set_freq_corr</definition>
        <argsstring>(int ppm)</argsstring>
        <name>set_freq_corr</name>
        <reimplements refid="classgr_1_1fcdproplus_1_1fcdproplus_1abe8d939abb9796260b052c11e658bddf">set_freq_corr</reimplements>
        <param>
          <type>int</type>
          <declname>ppm</declname>
        </param>
        <briefdescription>
<para>Set new frequency correction. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>ppm</parametername>
</parameternamelist>
<parameterdescription>
<para>The new frequency correction in parts per million</para>
</parameterdescription>
</parameteritem>
</parameterlist>
Funcube recommends 0 for the Pro+.</para>
<para>Ref: <ulink url="http://www.funcubedongle.com/MyImages/FCD2ManualV4.pdf">http://www.funcubedongle.com/MyImages/FCD2ManualV4.pdf</ulink> </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/lib/fcdproplus_impl.h" line="55" column="1"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fcdproplus_1_1fcdproplus__impl_1aa1e44da35ea983902849ef48a8590ef8" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>void</type>
        <definition>void gr::fcdproplus::fcdproplus_impl::set_if_gain</definition>
        <argsstring>(int gain)</argsstring>
        <name>set_if_gain</name>
        <reimplements refid="classgr_1_1fcdproplus_1_1fcdproplus_1ae931b647f16d552a725b0f9ee406aa5a">set_if_gain</reimplements>
        <param>
          <type>int</type>
          <declname>gain</declname>
        </param>
        <briefdescription>
<para>Set If gain. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>gain</parametername>
</parameternamelist>
<parameterdescription>
<para>The If gain value between 0 and 59 db </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/lib/fcdproplus_impl.h" line="56" column="1"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="5">
        <label>gr::fcdproplus::fcdproplus_impl</label>
        <link refid="classgr_1_1fcdproplus_1_1fcdproplus__impl"/>
        <childnode refid="6" relation="public-inheritance">
        </childnode>
      </node>
      <node id="6">
        <label>gr::fcdproplus::fcdproplus</label>
        <link refid="classgr_1_1fcdproplus_1_1fcdproplus"/>
        <childnode refid="7" relation="public-inheritance">
        </childnode>
      </node>
      <node id="7">
        <label>hier_block2</label>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="8">
        <label>gr::fcdproplus::fcdproplus_impl</label>
        <link refid="classgr_1_1fcdproplus_1_1fcdproplus__impl"/>
        <childnode refid="9" relation="public-inheritance">
        </childnode>
      </node>
      <node id="9">
        <label>gr::fcdproplus::fcdproplus</label>
        <link refid="classgr_1_1fcdproplus_1_1fcdproplus"/>
        <childnode refid="10" relation="public-inheritance">
        </childnode>
      </node>
      <node id="10">
        <label>hier_block2</label>
      </node>
    </collaborationgraph>
    <location file="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/lib/fcdproplus_impl.h" line="38" column="1" bodyfile="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/lib/fcdproplus_impl.h" bodystart="37" bodyend="58"/>
    <listofallmembers>
      <member refid="classgr_1_1fcdproplus_1_1fcdproplus__impl_1af15c47643eb14064656ac968929e2c47" prot="private" virt="non-virtual"><scope>gr::fcdproplus::fcdproplus_impl</scope><name>aucBuf</name></member>
      <member refid="classgr_1_1fcdproplus_1_1fcdproplus__impl_1a3f46925aec26be17dfd06d31442bc03d" prot="private" virt="non-virtual"><scope>gr::fcdproplus::fcdproplus_impl</scope><name>d_control_handle</name></member>
      <member refid="classgr_1_1fcdproplus_1_1fcdproplus__impl_1a0abcaad14fce11cf1be3f9ba5ef46aaf" prot="private" virt="non-virtual"><scope>gr::fcdproplus::fcdproplus_impl</scope><name>d_corr</name></member>
      <member refid="classgr_1_1fcdproplus_1_1fcdproplus__impl_1abb7e2296b8a008cf471dda8232832106" prot="private" virt="non-virtual"><scope>gr::fcdproplus::fcdproplus_impl</scope><name>d_freq_req</name></member>
      <member refid="classgr_1_1fcdproplus_1_1fcdproplus__impl_1a35334c28876ad7803997eac3e38d4a2d" prot="private" virt="non-virtual"><scope>gr::fcdproplus::fcdproplus_impl</scope><name>d_unit</name></member>
      <member refid="classgr_1_1fcdproplus_1_1fcdproplus__impl_1a0541a6aa5692ca2b26e121859a00598f" prot="private" virt="non-virtual"><scope>gr::fcdproplus::fcdproplus_impl</scope><name>fcd</name></member>
      <member refid="classgr_1_1fcdproplus_1_1fcdproplus__impl_1af5600a501a95ef3aa0cca33fcb22819d" prot="public" virt="non-virtual"><scope>gr::fcdproplus::fcdproplus_impl</scope><name>fcdproplus_impl</name></member>
      <member refid="classgr_1_1fcdproplus_1_1fcdproplus_1a43b18abe293f09b406ff113bd8a7ae5f" prot="public" virt="non-virtual"><scope>gr::fcdproplus::fcdproplus_impl</scope><name>make</name></member>
      <member refid="classgr_1_1fcdproplus_1_1fcdproplus__impl_1a734fbbf5e52b2782012eb9c3cd76e51d" prot="public" virt="virtual"><scope>gr::fcdproplus::fcdproplus_impl</scope><name>set_freq</name></member>
      <member refid="classgr_1_1fcdproplus_1_1fcdproplus__impl_1a41415b4f9daf64e7a0d378e47f1c448b" prot="public" virt="virtual"><scope>gr::fcdproplus::fcdproplus_impl</scope><name>set_freq_corr</name></member>
      <member refid="classgr_1_1fcdproplus_1_1fcdproplus__impl_1aa1e44da35ea983902849ef48a8590ef8" prot="public" virt="virtual"><scope>gr::fcdproplus::fcdproplus_impl</scope><name>set_if_gain</name></member>
      <member refid="classgr_1_1fcdproplus_1_1fcdproplus__impl_1a34dc8b14252bf76f729d379ec260d512" prot="public" virt="virtual"><scope>gr::fcdproplus::fcdproplus_impl</scope><name>set_lna</name></member>
      <member refid="classgr_1_1fcdproplus_1_1fcdproplus__impl_1ad491b9b81af03bb3893ce8ab004a41d3" prot="public" virt="virtual"><scope>gr::fcdproplus::fcdproplus_impl</scope><name>set_mixer_gain</name></member>
      <member refid="classgr_1_1fcdproplus_1_1fcdproplus_1aecfbd15d08a9500223ac75bee3a493c4" prot="public" virt="non-virtual"><scope>gr::fcdproplus::fcdproplus_impl</scope><name>sptr</name></member>
      <member refid="classgr_1_1fcdproplus_1_1fcdproplus__impl_1a4830e2af49e2f1cd2f0b58903ff0fd69" prot="public" virt="non-virtual"><scope>gr::fcdproplus::fcdproplus_impl</scope><name>~fcdproplus_impl</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>