Sophie

Sophie

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

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__vmcircbuf__mmap__shm__open__factory" kind="class" prot="public">
    <compoundname>gr_vmcircbuf_mmap_shm_open_factory</compoundname>
    <basecompoundref refid="classgr__vmcircbuf__factory" prot="public" virt="non-virtual">gr_vmcircbuf_factory</basecompoundref>
    <includes refid="gr__vmcircbuf__mmap__shm__open_8h" local="no">gr_vmcircbuf_mmap_shm_open.h</includes>
      <sectiondef kind="private-static-attrib">
      <memberdef kind="variable" id="classgr__vmcircbuf__mmap__shm__open__factory_1ae2a23204760c5b2a241fa8d216aa910e" prot="private" static="yes" mutable="no">
        <type><ref refid="classgr__vmcircbuf__factory" kindref="compound">gr_vmcircbuf_factory</ref> *</type>
        <definition>gr_vmcircbuf_factory* gr_vmcircbuf_mmap_shm_open_factory::s_the_factory</definition>
        <argsstring></argsstring>
        <name>s_the_factory</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_shm_open.h" line="46" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_shm_open.h" bodystart="46" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-static-func">
      <memberdef kind="function" id="classgr__vmcircbuf__mmap__shm__open__factory_1ac3003e43ff5d69eca049959a54cb7e05" prot="public" static="yes" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="classgr__vmcircbuf__factory" kindref="compound">gr_vmcircbuf_factory</ref> *</type>
        <definition>static gr_vmcircbuf_factory* gr_vmcircbuf_mmap_shm_open_factory::singleton</definition>
        <argsstring>()</argsstring>
        <name>singleton</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_shm_open.h" line="49"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="public-func">
      <memberdef kind="function" id="classgr__vmcircbuf__mmap__shm__open__factory_1a32b247e41531e9162e7c2d43ca5f0425" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="virtual">
        <type>const char *</type>
        <definition>virtual const char* gr_vmcircbuf_mmap_shm_open_factory::name</definition>
        <argsstring>() const </argsstring>
        <name>name</name>
        <reimplements refid="classgr__vmcircbuf__factory_1ac8f96616c04ac03db2c5f9fa0c2d728d">name</reimplements>
        <briefdescription>
<para>return name of this factory </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_shm_open.h" line="51" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_shm_open.h" bodystart="51" bodyend="51"/>
      </memberdef>
      <memberdef kind="function" id="classgr__vmcircbuf__mmap__shm__open__factory_1ae5fc13be16d326275a05e178daacc6db" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type>int</type>
        <definition>virtual int gr_vmcircbuf_mmap_shm_open_factory::granularity</definition>
        <argsstring>()</argsstring>
        <name>granularity</name>
        <reimplements refid="classgr__vmcircbuf__factory_1a1e6730e738aef0a4164538ce8bcf5e8d">granularity</reimplements>
        <briefdescription>
<para>return granularity of mapping, typically equal to page size </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_shm_open.h" line="56"/>
      </memberdef>
      <memberdef kind="function" id="classgr__vmcircbuf__mmap__shm__open__factory_1a36d1a5b9ec8316b5c49257fada79d5f3" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
        <type><ref refid="classgr__vmcircbuf" kindref="compound">gr_vmcircbuf</ref> *</type>
        <definition>virtual gr_vmcircbuf* gr_vmcircbuf_mmap_shm_open_factory::make</definition>
        <argsstring>(int size)</argsstring>
        <name>make</name>
        <reimplements refid="classgr__vmcircbuf__factory_1a93e1d9a839a9edc332e1b7b9eb594293">make</reimplements>
        <param>
          <type>int</type>
          <declname>size</declname>
        </param>
        <briefdescription>
<para>return a <ref refid="classgr__vmcircbuf" kindref="compound">gr_vmcircbuf</ref>, or 0 if unable. </para>        </briefdescription>
        <detaileddescription>
<para>Call this to create a doubly mapped circular buffer. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_shm_open.h" line="63"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>concrete factory for circular buffers built using mmap and shm_open </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <inheritancegraph>
      <node id="14411">
        <label>gr_vmcircbuf_mmap_shm_open_factory</label>
        <link refid="classgr__vmcircbuf__mmap__shm__open__factory"/>
        <childnode refid="14412" relation="public-inheritance">
        </childnode>
      </node>
      <node id="14412">
        <label>gr_vmcircbuf_factory</label>
        <link refid="classgr__vmcircbuf__factory"/>
      </node>
    </inheritancegraph>
    <collaborationgraph>
      <node id="14413">
        <label>gr_vmcircbuf_mmap_shm_open_factory</label>
        <link refid="classgr__vmcircbuf__mmap__shm__open__factory"/>
        <childnode refid="14414" relation="public-inheritance">
        </childnode>
        <childnode refid="14414" relation="usage">
          <edgelabel>s_the_factory</edgelabel>
        </childnode>
      </node>
      <node id="14414">
        <label>gr_vmcircbuf_factory</label>
        <link refid="classgr__vmcircbuf__factory"/>
      </node>
    </collaborationgraph>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_shm_open.h" line="44" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_shm_open.h" bodystart="44" bodyend="64"/>
    <listofallmembers>
      <member refid="classgr__vmcircbuf__factory_1a5d08857f4d2c09b0bd027963cf904a10" prot="protected" virt="non-virtual"><scope>gr_vmcircbuf_mmap_shm_open_factory</scope><name>gr_vmcircbuf_factory</name></member>
      <member refid="classgr__vmcircbuf__mmap__shm__open__factory_1ae5fc13be16d326275a05e178daacc6db" prot="public" virt="virtual"><scope>gr_vmcircbuf_mmap_shm_open_factory</scope><name>granularity</name></member>
      <member refid="classgr__vmcircbuf__mmap__shm__open__factory_1a36d1a5b9ec8316b5c49257fada79d5f3" prot="public" virt="virtual"><scope>gr_vmcircbuf_mmap_shm_open_factory</scope><name>make</name></member>
      <member refid="classgr__vmcircbuf__mmap__shm__open__factory_1a32b247e41531e9162e7c2d43ca5f0425" prot="public" virt="virtual"><scope>gr_vmcircbuf_mmap_shm_open_factory</scope><name>name</name></member>
      <member refid="classgr__vmcircbuf__mmap__shm__open__factory_1ae2a23204760c5b2a241fa8d216aa910e" prot="private" virt="non-virtual"><scope>gr_vmcircbuf_mmap_shm_open_factory</scope><name>s_the_factory</name></member>
      <member refid="classgr__vmcircbuf__mmap__shm__open__factory_1ac3003e43ff5d69eca049959a54cb7e05" prot="public" virt="non-virtual"><scope>gr_vmcircbuf_mmap_shm_open_factory</scope><name>singleton</name></member>
      <member refid="classgr__vmcircbuf__factory_1af7b1bc5f8cf80eadd8f771a8931e10cf" prot="protected" virt="virtual"><scope>gr_vmcircbuf_mmap_shm_open_factory</scope><name>~gr_vmcircbuf_factory</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>