Sophie

Sophie

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

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="classi2c__bitbang" kind="class" prot="public">
    <compoundname>i2c_bitbang</compoundname>
    <basecompoundref refid="classi2c" prot="public" virt="non-virtual">i2c</basecompoundref>
    <includes refid="i2c__bitbang_8h" local="no">i2c_bitbang.h</includes>
      <sectiondef kind="private-attrib">
      <memberdef kind="variable" id="classi2c__bitbang_1ac00bc2c682831920fb97dd27bf358659" prot="private" static="no" mutable="no">
        <type><ref refid="classboost_1_1shared__ptr" kindref="compound">i2c_bbio_sptr</ref></type>
        <definition>i2c_bbio_sptr i2c_bitbang::d_io</definition>
        <argsstring></argsstring>
        <name>d_io</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/i2c_bitbang.h" line="57" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/i2c_bitbang.h" bodystart="57" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="friend">
      <memberdef kind="friend" id="classi2c__bitbang_1a2c1399f8888b727e1dff4ccf22d07628" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>friend <ref refid="classboost_1_1shared__ptr" kindref="compound">i2c_sptr</ref></type>
        <definition>i2c_sptr make_i2c_bitbang</definition>
        <argsstring>(i2c_bbio_sptr io)</argsstring>
        <name>make_i2c_bitbang</name>
        <param>
          <type><ref refid="classboost_1_1shared__ptr" kindref="compound">i2c_bbio_sptr</ref></type>
          <declname>io</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/i2c_bitbang.h" line="34"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="classi2c__bitbang_1a30f13b33c6bd629ad2143ddd3df955a9" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type></type>
        <definition>i2c_bitbang::i2c_bitbang</definition>
        <argsstring>(i2c_bbio_sptr io)</argsstring>
        <name>i2c_bitbang</name>
        <param>
          <type><ref refid="classboost_1_1shared__ptr" kindref="compound">i2c_bbio_sptr</ref></type>
          <declname>io</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/i2c_bitbang.h" line="35"/>
      </memberdef>
      <memberdef kind="function" id="classi2c__bitbang_1af62812d12aed3441622f85e073e736e4" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void i2c_bitbang::start</definition>
        <argsstring>()</argsstring>
        <name>start</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/i2c_bitbang.h" line="48"/>
      </memberdef>
      <memberdef kind="function" id="classi2c__bitbang_1aa98ed5a2644555e1d1ed5ece63ba05f9" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void i2c_bitbang::stop</definition>
        <argsstring>()</argsstring>
        <name>stop</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/i2c_bitbang.h" line="49"/>
      </memberdef>
      <memberdef kind="function" id="classi2c__bitbang_1ad0ec55782b7b9f4d1ec09f45540e9492" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>void</type>
        <definition>void i2c_bitbang::write_bit</definition>
        <argsstring>(bool bit)</argsstring>
        <name>write_bit</name>
        <param>
          <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
          <declname>bit</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/i2c_bitbang.h" line="50"/>
      </memberdef>
      <memberdef kind="function" id="classi2c__bitbang_1a6d79348d31481acd9abf1e7c66d6cca5" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>bool i2c_bitbang::write_byte</definition>
        <argsstring>(char byte)</argsstring>
        <name>write_byte</name>
        <param>
          <type>char</type>
          <declname>byte</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/i2c_bitbang.h" line="51"/>
      </memberdef>
      <memberdef kind="function" id="classi2c__bitbang_1a00a0cad524253399d69399b1854f0780" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>void</type>
        <definition>void i2c_bitbang::set_sda</definition>
        <argsstring>(bool bit)</argsstring>
        <name>set_sda</name>
        <param>
          <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
          <declname>bit</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/i2c_bitbang.h" line="53" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/i2c_bitbang.h" bodystart="53" bodyend="53"/>
      </memberdef>
      <memberdef kind="function" id="classi2c__bitbang_1a7f022c71545651dc31b0281752a93eef" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type>void</type>
        <definition>void i2c_bitbang::set_scl</definition>
        <argsstring>(bool bit)</argsstring>
        <name>set_scl</name>
        <param>
          <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
          <declname>bit</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/i2c_bitbang.h" line="54" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/i2c_bitbang.h" bodystart="54" bodyend="54"/>
      </memberdef>
      <memberdef kind="function" id="classi2c__bitbang_1ae4f564865b88db18b489e5e93415beae" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>bool i2c_bitbang::get_sda</definition>
        <argsstring>()</argsstring>
        <name>get_sda</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/i2c_bitbang.h" line="55" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/i2c_bitbang.h" bodystart="55" bodyend="55"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classi2c__bitbang_1aadb3fd0bbe3d812470edfa26cb8da773" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type></type>
        <definition>i2c_bitbang::~i2c_bitbang</definition>
        <argsstring>()</argsstring>
        <name>~i2c_bitbang</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/i2c_bitbang.h" line="38" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/i2c_bitbang.h" bodystart="38" bodyend="38"/>
      </memberdef>
      <memberdef kind="function" id="classi2c__bitbang_1a36b313126b420123bceacb962cc871e5" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type><ref refid="gc__types_8h_1a0f2b5d454b7e4dda3861032cfce91085" kindref="member">bool</ref></type>
        <definition>bool i2c_bitbang::write</definition>
        <argsstring>(int addr, const unsigned char *buf, int nbytes)</argsstring>
        <name>write</name>
        <reimplements refid="classi2c_1a8900e88f60f3d8c7790f17f909bdbcfa">write</reimplements>
        <param>
          <type>int</type>
          <declname>addr</declname>
        </param>
        <param>
          <type>const unsigned char *</type>
          <declname>buf</declname>
        </param>
        <param>
          <type>int</type>
          <declname>nbytes</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para><simplesect kind="return"><para>true iff successful </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/i2c_bitbang.h" line="41"/>
      </memberdef>
      <memberdef kind="function" id="classi2c__bitbang_1aef0f57915960f3356707dd9a62496f36" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>int</type>
        <definition>int i2c_bitbang::read</definition>
        <argsstring>(int addr, unsigned char *buf, int max_bytes)</argsstring>
        <name>read</name>
        <reimplements refid="classi2c_1ab8cf2942ef888184214a18a2499a326b">read</reimplements>
        <param>
          <type>int</type>
          <declname>addr</declname>
        </param>
        <param>
          <type>unsigned char *</type>
          <declname>buf</declname>
        </param>
        <param>
          <type>int</type>
          <declname>max_bytes</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para><simplesect kind="return"><para>number of bytes read or -1 if error </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/i2c_bitbang.h" line="44"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>class for controlling <ref refid="classi2c" kindref="compound">i2c</ref> bus </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="14737">
        <label>i2c</label>
        <link refid="classi2c"/>
      </node>
      <node id="14736">
        <label>i2c_bitbang</label>
        <link refid="classi2c__bitbang"/>
        <childnode refid="14737" relation="public-inheritance">
        </childnode>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="14740">
        <label>boost::shared_ptr&lt; i2c_bbio &gt;</label>
        <link refid="classboost_1_1shared__ptr"/>
        <childnode refid="14741" relation="usage">
          <edgelabel>px</edgelabel>
        </childnode>
      </node>
      <node id="14741">
        <label>i2c_bbio</label>
        <link refid="classi2c__bbio"/>
      </node>
      <node id="14739">
        <label>i2c</label>
        <link refid="classi2c"/>
      </node>
      <node id="14738">
        <label>i2c_bitbang</label>
        <link refid="classi2c__bitbang"/>
        <childnode refid="14739" relation="public-inheritance">
        </childnode>
        <childnode refid="14740" relation="usage">
          <edgelabel>d_io</edgelabel>
        </childnode>
      </node>
    </collaborationgraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/i2c_bitbang.h" line="33" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/io/i2c_bitbang.h" bodystart="33" bodyend="58"/>
    <listofallmembers>
      <member refid="classi2c__bitbang_1ac00bc2c682831920fb97dd27bf358659" prot="private" virt="non-virtual"><scope>i2c_bitbang</scope><name>d_io</name></member>
      <member refid="classi2c__bitbang_1ae4f564865b88db18b489e5e93415beae" prot="private" virt="non-virtual"><scope>i2c_bitbang</scope><name>get_sda</name></member>
      <member refid="classi2c_1a5052b59bf4913cbbf093f19260fe25bb" prot="public" virt="non-virtual"><scope>i2c_bitbang</scope><name>i2c</name></member>
      <member refid="classi2c__bitbang_1a30f13b33c6bd629ad2143ddd3df955a9" prot="private" virt="non-virtual"><scope>i2c_bitbang</scope><name>i2c_bitbang</name></member>
      <member refid="classi2c__bitbang_1a2c1399f8888b727e1dff4ccf22d07628" prot="private" virt="non-virtual"><scope>i2c_bitbang</scope><name>make_i2c_bitbang</name></member>
      <member refid="classi2c__bitbang_1aef0f57915960f3356707dd9a62496f36" prot="public" virt="virtual"><scope>i2c_bitbang</scope><name>read</name></member>
      <member refid="classi2c__bitbang_1a7f022c71545651dc31b0281752a93eef" prot="private" virt="non-virtual"><scope>i2c_bitbang</scope><name>set_scl</name></member>
      <member refid="classi2c__bitbang_1a00a0cad524253399d69399b1854f0780" prot="private" virt="non-virtual"><scope>i2c_bitbang</scope><name>set_sda</name></member>
      <member refid="classi2c__bitbang_1af62812d12aed3441622f85e073e736e4" prot="private" virt="non-virtual"><scope>i2c_bitbang</scope><name>start</name></member>
      <member refid="classi2c__bitbang_1aa98ed5a2644555e1d1ed5ece63ba05f9" prot="private" virt="non-virtual"><scope>i2c_bitbang</scope><name>stop</name></member>
      <member refid="classi2c__bitbang_1a36b313126b420123bceacb962cc871e5" prot="public" virt="virtual"><scope>i2c_bitbang</scope><name>write</name></member>
      <member refid="classi2c__bitbang_1ad0ec55782b7b9f4d1ec09f45540e9492" prot="private" virt="non-virtual"><scope>i2c_bitbang</scope><name>write_bit</name></member>
      <member refid="classi2c__bitbang_1a6d79348d31481acd9abf1e7c66d6cca5" prot="private" virt="non-virtual"><scope>i2c_bitbang</scope><name>write_byte</name></member>
      <member refid="classi2c_1afd966136eb0a535bc31b2ac2d2edc37d" prot="public" virt="virtual"><scope>i2c_bitbang</scope><name>~i2c</name></member>
      <member refid="classi2c__bitbang_1aadb3fd0bbe3d812470edfa26cb8da773" prot="public" virt="non-virtual"><scope>i2c_bitbang</scope><name>~i2c_bitbang</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>