Sophie

Sophie

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

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" kind="class" language="C++" prot="public" abstract="yes">
    <compoundname>gr::fcdproplus::fcdproplus</compoundname>
    <basecompoundref prot="public" virt="virtual">hier_block2</basecompoundref>
    <derivedcompoundref refid="classgr_1_1fcdproplus_1_1fcdproplus__impl" prot="public" virt="non-virtual">gr::fcdproplus::fcdproplus_impl</derivedcompoundref>
    <includes refid="fcdproplus_8h" local="no">fcdproplus.h</includes>
      <sectiondef kind="public-type">
      <memberdef kind="typedef" id="classgr_1_1fcdproplus_1_1fcdproplus_1aecfbd15d08a9500223ac75bee3a493c4" prot="public" static="no">
        <type>boost::shared_ptr&lt; <ref refid="classgr_1_1fcdproplus_1_1fcdproplus" kindref="compound">fcdproplus</ref> &gt;</type>
        <definition>typedef boost::shared_ptr&lt;fcdproplus&gt; gr::fcdproplus::fcdproplus::sptr</definition>
        <argsstring></argsstring>
        <name>sptr</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/include/fcdproplus/fcdproplus.h" line="49" column="1" bodyfile="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/include/fcdproplus/fcdproplus.h" bodystart="49" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-static-func">
      <memberdef kind="function" id="classgr_1_1fcdproplus_1_1fcdproplus_1a43b18abe293f09b406ff113bd8a7ae5f" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="classgr_1_1fcdproplus_1_1fcdproplus_1aecfbd15d08a9500223ac75bee3a493c4" kindref="member">sptr</ref></type>
        <definition>static sptr gr::fcdproplus::fcdproplus::make</definition>
        <argsstring>(const std::string device_name=&quot;&quot;, int unit=1)</argsstring>
        <name>make</name>
        <param>
          <type>const std::string</type>
          <declname>device_name</declname>
          <defval>&quot;&quot;</defval>
        </param>
        <param>
          <type>int</type>
          <declname>unit</declname>
          <defval>1</defval>
        </param>
        <briefdescription>
<para>Return a shared_ptr to a new instance of <ref refid="classgr_1_1fcdproplus_1_1fcdproplus" kindref="compound">fcdproplus::fcdproplus</ref>. </para>
        </briefdescription>
        <detaileddescription>
<para>To avoid accidental use of raw pointers, <ref refid="classgr_1_1fcdproplus_1_1fcdproplus" kindref="compound">fcdproplus::fcdproplus</ref>&apos;s constructor is in a private implementation class. <ref refid="classgr_1_1fcdproplus_1_1fcdproplus_1a43b18abe293f09b406ff113bd8a7ae5f" kindref="member">fcdproplus::fcdproplus::make</ref> is the public interface for creating new instances. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/include/fcdproplus/fcdproplus.h" line="59" column="1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classgr_1_1fcdproplus_1_1fcdproplus_1a9da58f91e3c6ee69f380d2f4eb5c997a" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>void</type>
        <definition>virtual void gr::fcdproplus::fcdproplus::set_freq</definition>
        <argsstring>(float freq)=0</argsstring>
        <name>set_freq</name>
        <reimplementedby refid="classgr_1_1fcdproplus_1_1fcdproplus__impl_1a734fbbf5e52b2782012eb9c3cd76e51d">set_freq</reimplementedby>
        <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_1abe8d939abb9796260b052c11e658bddf" kindref="member">set_freq_corr()</ref>. </para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/include/fcdproplus/fcdproplus.h" line="69" column="1"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fcdproplus_1_1fcdproplus_1a0b8e92206019aa63e68125d4a6705280" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>void</type>
        <definition>virtual void gr::fcdproplus::fcdproplus::set_lna</definition>
        <argsstring>(int gain)=0</argsstring>
        <name>set_lna</name>
        <reimplementedby refid="classgr_1_1fcdproplus_1_1fcdproplus__impl_1a34dc8b14252bf76f729d379ec260d512">set_lna</reimplementedby>
        <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/include/fcdproplus/fcdproplus.h" line="75" column="1"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fcdproplus_1_1fcdproplus_1a4300449c9276498849c929f7e30189aa" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>void</type>
        <definition>virtual void gr::fcdproplus::fcdproplus::set_mixer_gain</definition>
        <argsstring>(int gain)=0</argsstring>
        <name>set_mixer_gain</name>
        <reimplementedby refid="classgr_1_1fcdproplus_1_1fcdproplus__impl_1ad491b9b81af03bb3893ce8ab004a41d3">set_mixer_gain</reimplementedby>
        <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/include/fcdproplus/fcdproplus.h" line="81" column="1"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fcdproplus_1_1fcdproplus_1abe8d939abb9796260b052c11e658bddf" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>void</type>
        <definition>virtual void gr::fcdproplus::fcdproplus::set_freq_corr</definition>
        <argsstring>(int ppm)=0</argsstring>
        <name>set_freq_corr</name>
        <reimplementedby refid="classgr_1_1fcdproplus_1_1fcdproplus__impl_1a41415b4f9daf64e7a0d378e47f1c448b">set_freq_corr</reimplementedby>
        <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/include/fcdproplus/fcdproplus.h" line="90" column="1"/>
      </memberdef>
      <memberdef kind="function" id="classgr_1_1fcdproplus_1_1fcdproplus_1ae931b647f16d552a725b0f9ee406aa5a" prot="public" static="no" const="no" explicit="no" inline="no" virt="pure-virtual">
        <type>void</type>
        <definition>virtual void gr::fcdproplus::fcdproplus::set_if_gain</definition>
        <argsstring>(int gain)=0</argsstring>
        <name>set_if_gain</name>
        <reimplementedby refid="classgr_1_1fcdproplus_1_1fcdproplus__impl_1aa1e44da35ea983902849ef48a8590ef8">set_if_gain</reimplementedby>
        <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/include/fcdproplus/fcdproplus.h" line="96" column="1"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Funcube Pro+ Dongle source block. </para>
    </briefdescription>
    <detaileddescription>
<para>This class provides a soure block for the Funcube Pro+ Dongle by wrapping the alsa audio interface and the USB control interface of the Funcube Dongle into one convenient source block. The hadware audio device is autodetected by the card name. If more than one Pro+ are connected it takes the first card. The block was tested with firmware version 20.3 </para>
    </detaileddescription>
    <inheritancegraph>
      <node id="2">
        <label>gr::fcdproplus::fcdproplus_impl</label>
        <link refid="classgr_1_1fcdproplus_1_1fcdproplus__impl"/>
        <childnode refid="0" relation="public-inheritance">
        </childnode>
      </node>
      <node id="0">
        <label>gr::fcdproplus::fcdproplus</label>
        <link refid="classgr_1_1fcdproplus_1_1fcdproplus"/>
        <childnode refid="1" relation="public-inheritance">
        </childnode>
      </node>
      <node id="1">
        <label>hier_block2</label>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="3">
        <label>gr::fcdproplus::fcdproplus</label>
        <link refid="classgr_1_1fcdproplus_1_1fcdproplus"/>
        <childnode refid="4" relation="public-inheritance">
        </childnode>
      </node>
      <node id="4">
        <label>hier_block2</label>
      </node>
    </collaborationgraph>
    <location file="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/include/fcdproplus/fcdproplus.h" line="47" column="1" bodyfile="/home/iurt/rpmbuild/BUILD/gr-fcdproplus-3.7.12/include/fcdproplus/fcdproplus.h" bodystart="46" bodyend="98"/>
    <listofallmembers>
      <member refid="classgr_1_1fcdproplus_1_1fcdproplus_1a43b18abe293f09b406ff113bd8a7ae5f" prot="public" virt="non-virtual"><scope>gr::fcdproplus::fcdproplus</scope><name>make</name></member>
      <member refid="classgr_1_1fcdproplus_1_1fcdproplus_1a9da58f91e3c6ee69f380d2f4eb5c997a" prot="public" virt="pure-virtual"><scope>gr::fcdproplus::fcdproplus</scope><name>set_freq</name></member>
      <member refid="classgr_1_1fcdproplus_1_1fcdproplus_1abe8d939abb9796260b052c11e658bddf" prot="public" virt="pure-virtual"><scope>gr::fcdproplus::fcdproplus</scope><name>set_freq_corr</name></member>
      <member refid="classgr_1_1fcdproplus_1_1fcdproplus_1ae931b647f16d552a725b0f9ee406aa5a" prot="public" virt="pure-virtual"><scope>gr::fcdproplus::fcdproplus</scope><name>set_if_gain</name></member>
      <member refid="classgr_1_1fcdproplus_1_1fcdproplus_1a0b8e92206019aa63e68125d4a6705280" prot="public" virt="pure-virtual"><scope>gr::fcdproplus::fcdproplus</scope><name>set_lna</name></member>
      <member refid="classgr_1_1fcdproplus_1_1fcdproplus_1a4300449c9276498849c929f7e30189aa" prot="public" virt="pure-virtual"><scope>gr::fcdproplus::fcdproplus</scope><name>set_mixer_gain</name></member>
      <member refid="classgr_1_1fcdproplus_1_1fcdproplus_1aecfbd15d08a9500223ac75bee3a493c4" prot="public" virt="non-virtual"><scope>gr::fcdproplus::fcdproplus</scope><name>sptr</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>