Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 6e7a2755bd78c9deedab199b86e675f3 > files > 7821

gnuradio-doc-3.2.2-9.fc14.x86_64.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.7.3">
  <compounddef id="classgr__timer" kind="class" prot="public">
    <compoundname>gr_timer</compoundname>
    <includes refid="gr__timer_8h" local="no">gr_timer.h</includes>
      <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classgr__timer_1ae4b2dfeda208cc403f1737b21879d36d" prot="private" static="no" mutable="no">
        <type>double</type>
        <definition>double gr_timer::d_expiry</definition>
        <argsstring></argsstring>
        <name>d_expiry</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_timer.h" line="45" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_timer.h" bodystart="45" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__timer_1ab11d9b9ee10866d141fe84ae6fb8c72a" prot="private" static="no" mutable="no">
        <type>double</type>
        <definition>double gr_timer::d_period</definition>
        <argsstring></argsstring>
        <name>d_period</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_timer.h" line="46" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_timer.h" bodystart="46" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__timer_1a20b0c89aae05d07eaef30e8245457e8e" prot="private" static="no" mutable="no">
        <type><ref refid="gr__timer_8h_1aaad1a7988cefaef6f86f25ce635e6162" kindref="member">gr_timer_hook</ref></type>
        <definition>gr_timer_hook gr_timer::d_hook</definition>
        <argsstring></argsstring>
        <name>d_hook</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_timer.h" line="47" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_timer.h" bodystart="47" bodyend="-1"/>
      </memberdef>
      <memberdef kind="variable" id="classgr__timer_1ab77aa16b0a4fa6e800e662ccb5a371fa" prot="private" static="no" mutable="no">
        <type>void *</type>
        <definition>void* gr_timer::d_hook_arg</definition>
        <argsstring></argsstring>
        <name>d_hook_arg</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_timer.h" line="48" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_timer.h" bodystart="48" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="friend">
      <memberdef kind="friend" id="classgr__timer_1a54c4024986ca4db5b59761ae5c15ccbe" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>friend <ref refid="classboost_1_1shared__ptr" kindref="compound">gr_timer_sptr</ref></type>
        <definition>gr_timer_sptr gr_make_timer</definition>
        <argsstring>(gr_timer_hook, void *)</argsstring>
        <name>gr_make_timer</name>
        <param>
          <type><ref refid="gr__timer_8h_1aaad1a7988cefaef6f86f25ce635e6162" kindref="member">gr_timer_hook</ref></type>
        </param>
        <param>
          <type>void *</type>
        </param>
        <briefdescription>
<para>create a timeout. </para>        </briefdescription>
        <detaileddescription>
<para>gr_timer_hook is called when timer fires. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_timer.h" line="50"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="classgr__timer_1a3b5d92cd8258f72509ca6723f26e9c45" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>gr_timer::gr_timer</definition>
        <argsstring>(...)</argsstring>
        <name>gr_timer</name>
        <param>
          <type>...</type>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_timer.h" line="52"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classgr__timer_1a253ab647fa0383d51ad9eb138ee392bb" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>gr_timer::~gr_timer</definition>
        <argsstring>()</argsstring>
        <name>~gr_timer</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_timer.h" line="55"/>
      </memberdef>
      <memberdef kind="function" id="classgr__timer_1ab781a88ff4cc3e0df4f9c0f1c9476191" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void gr_timer::schedule_at</definition>
        <argsstring>(double abs_when)</argsstring>
        <name>schedule_at</name>
        <param>
          <type>double</type>
          <declname>abs_when</declname>
        </param>
        <briefdescription>
<para>schedule timer to fire at abs_when </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>abs_when</parametername>
</parameternamelist>
<parameterdescription>
<para>absolute time in seconds since the epoc. </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_timer.h" line="64"/>
      </memberdef>
      <memberdef kind="function" id="classgr__timer_1a984ee98c414f274071e02738c9b540f0" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void gr_timer::schedule_after</definition>
        <argsstring>(double rel_when)</argsstring>
        <name>schedule_after</name>
        <param>
          <type>double</type>
          <declname>rel_when</declname>
        </param>
        <briefdescription>
<para>schedule timer to fire rel_when seconds from now. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>rel_when</parametername>
</parameternamelist>
<parameterdescription>
<para>relative time in seconds from now. </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_timer.h" line="70"/>
      </memberdef>
      <memberdef kind="function" id="classgr__timer_1a8b34271c4cfc0ac9d3f145db3d66e9d2" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void gr_timer::schedule_periodic</definition>
        <argsstring>(double abs_when, double period)</argsstring>
        <name>schedule_periodic</name>
        <param>
          <type>double</type>
          <declname>abs_when</declname>
        </param>
        <param>
          <type>double</type>
          <declname>period</declname>
        </param>
        <briefdescription>
<para>schedule a periodic timeout. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>abs_when</parametername>
</parameternamelist>
<parameterdescription>
<para>absolute time to fire first time </para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>period</parametername>
</parameternamelist>
<parameterdescription>
<para>time between firings </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_timer.h" line="77"/>
      </memberdef>
      <memberdef kind="function" id="classgr__timer_1a0e145fa5b0ea597fa0853498b18f6a0a" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void gr_timer::unschedule</definition>
        <argsstring>()</argsstring>
        <name>unschedule</name>
        <briefdescription>
<para>cancel timer </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_timer.h" line="80"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-static-func">
      <memberdef kind="function" id="classgr__timer_1aa6e9cdb89da2b3aa07af41b771c24ba8" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>double</type>
        <definition>static double gr_timer::now</definition>
        <argsstring>()</argsstring>
        <name>now</name>
        <briefdescription>
<para>return absolute current time (seconds since the epoc). </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_timer.h" line="58"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>implement timeouts </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_timer.h" line="44" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_timer.h" bodystart="44" bodyend="81"/>
    <listofallmembers>
      <member refid="classgr__timer_1ae4b2dfeda208cc403f1737b21879d36d" prot="private" virt="non-virtual"><scope>gr_timer</scope><name>d_expiry</name></member>
      <member refid="classgr__timer_1a20b0c89aae05d07eaef30e8245457e8e" prot="private" virt="non-virtual"><scope>gr_timer</scope><name>d_hook</name></member>
      <member refid="classgr__timer_1ab77aa16b0a4fa6e800e662ccb5a371fa" prot="private" virt="non-virtual"><scope>gr_timer</scope><name>d_hook_arg</name></member>
      <member refid="classgr__timer_1ab11d9b9ee10866d141fe84ae6fb8c72a" prot="private" virt="non-virtual"><scope>gr_timer</scope><name>d_period</name></member>
      <member refid="classgr__timer_1a54c4024986ca4db5b59761ae5c15ccbe" prot="private" virt="non-virtual"><scope>gr_timer</scope><name>gr_make_timer</name></member>
      <member refid="classgr__timer_1a3b5d92cd8258f72509ca6723f26e9c45" prot="private" virt="non-virtual"><scope>gr_timer</scope><name>gr_timer</name></member>
      <member refid="classgr__timer_1aa6e9cdb89da2b3aa07af41b771c24ba8" prot="public" virt="non-virtual"><scope>gr_timer</scope><name>now</name></member>
      <member refid="classgr__timer_1a984ee98c414f274071e02738c9b540f0" prot="public" virt="non-virtual"><scope>gr_timer</scope><name>schedule_after</name></member>
      <member refid="classgr__timer_1ab781a88ff4cc3e0df4f9c0f1c9476191" prot="public" virt="non-virtual"><scope>gr_timer</scope><name>schedule_at</name></member>
      <member refid="classgr__timer_1a8b34271c4cfc0ac9d3f145db3d66e9d2" prot="public" virt="non-virtual"><scope>gr_timer</scope><name>schedule_periodic</name></member>
      <member refid="classgr__timer_1a0e145fa5b0ea597fa0853498b18f6a0a" prot="public" virt="non-virtual"><scope>gr_timer</scope><name>unschedule</name></member>
      <member refid="classgr__timer_1a253ab647fa0383d51ad9eb138ee392bb" prot="public" virt="non-virtual"><scope>gr_timer</scope><name>~gr_timer</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>