<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GNU Radio 3.2.2 C++ API: gr_vmcircbuf_factory Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU Radio 3.2.2 C++ API</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classgr__vmcircbuf__factory.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>gr_vmcircbuf_factory Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="gr_vmcircbuf_factory" -->
<p>abstract factory for creating circular buffers
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__vmcircbuf_8h_source.html">gr_vmcircbuf.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_vmcircbuf_factory:</div>
<div class="dyncontent">
<div class="center"><img src="classgr__vmcircbuf__factory__inherit__graph.png" border="0" usemap="#gr__vmcircbuf__factory_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__vmcircbuf__factory_inherit__map" id="gr__vmcircbuf__factory_inherit__map">
<area shape="rect" id="node3" href="classgr__vmcircbuf__createfilemapping__factory.html" title="concrete factory for circular buffers built using mmap and shm_open" alt="" coords="199,5,452,35"/><area shape="rect" id="node5" href="classgr__vmcircbuf__mmap__shm__open__factory.html" title="concrete factory for circular buffers built using mmap and shm_open" alt="" coords="199,59,452,88"/><area shape="rect" id="node7" href="classgr__vmcircbuf__mmap__tmpfile__factory.html" title="concrete factory for circular buffers built using mmap and shm_open" alt="" coords="209,112,441,141"/><area shape="rect" id="node9" href="classgr__vmcircbuf__sysv__shm__factory.html" title="concrete factory for circular buffers built using mmap and shm_open" alt="" coords="220,165,431,195"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__vmcircbuf__factory-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__vmcircbuf__factory.html#ac8f96616c04ac03db2c5f9fa0c2d728d">name</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return name of this factory <a href="#ac8f96616c04ac03db2c5f9fa0c2d728d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__vmcircbuf__factory.html#a1e6730e738aef0a4164538ce8bcf5e8d">granularity</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return granularity of mapping, typically equal to page size <a href="#a1e6730e738aef0a4164538ce8bcf5e8d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classgr__vmcircbuf.html">gr_vmcircbuf</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__vmcircbuf__factory.html#a93e1d9a839a9edc332e1b7b9eb594293">make</a> (int size)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return a <a class="el" href="classgr__vmcircbuf.html" title="abstract class to implement doubly mapped virtual memory circular buffers">gr_vmcircbuf</a>, or 0 if unable. <a href="#a93e1d9a839a9edc332e1b7b9eb594293"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__vmcircbuf__factory.html#a5d08857f4d2c09b0bd027963cf904a10">gr_vmcircbuf_factory</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__vmcircbuf__factory.html#af7b1bc5f8cf80eadd8f771a8931e10cf">~gr_vmcircbuf_factory</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>abstract factory for creating circular buffers </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5d08857f4d2c09b0bd027963cf904a10"></a><!-- doxytag: member="gr_vmcircbuf_factory::gr_vmcircbuf_factory" ref="a5d08857f4d2c09b0bd027963cf904a10" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_vmcircbuf_factory::gr_vmcircbuf_factory </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af7b1bc5f8cf80eadd8f771a8931e10cf"></a><!-- doxytag: member="gr_vmcircbuf_factory::~gr_vmcircbuf_factory" ref="af7b1bc5f8cf80eadd8f771a8931e10cf" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual gr_vmcircbuf_factory::~gr_vmcircbuf_factory </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1e6730e738aef0a4164538ce8bcf5e8d"></a><!-- doxytag: member="gr_vmcircbuf_factory::granularity" ref="a1e6730e738aef0a4164538ce8bcf5e8d" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int gr_vmcircbuf_factory::granularity </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return granularity of mapping, typically equal to page size </p>
<p>Implemented in <a class="el" href="classgr__vmcircbuf__createfilemapping__factory.html#af9432da478e5bd419d7085d5c9ba02c2">gr_vmcircbuf_createfilemapping_factory</a>, <a class="el" href="classgr__vmcircbuf__mmap__shm__open__factory.html#ae5fc13be16d326275a05e178daacc6db">gr_vmcircbuf_mmap_shm_open_factory</a>, <a class="el" href="classgr__vmcircbuf__mmap__tmpfile__factory.html#af21cbed100a7518c960af20b570c93e6">gr_vmcircbuf_mmap_tmpfile_factory</a>, and <a class="el" href="classgr__vmcircbuf__sysv__shm__factory.html#a551727a238e3bb70091dfa8e6059c96f">gr_vmcircbuf_sysv_shm_factory</a>.</p>
<p>Referenced by <a class="el" href="classgr__vmcircbuf__sysconfig.html#aaae9e70d8b158d2e22b64c8ad283dbaa">gr_vmcircbuf_sysconfig::granularity()</a>.</p>
</div>
</div>
<a class="anchor" id="a93e1d9a839a9edc332e1b7b9eb594293"></a><!-- doxytag: member="gr_vmcircbuf_factory::make" ref="a93e1d9a839a9edc332e1b7b9eb594293" args="(int size)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classgr__vmcircbuf.html">gr_vmcircbuf</a>* gr_vmcircbuf_factory::make </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>size</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return a <a class="el" href="classgr__vmcircbuf.html" title="abstract class to implement doubly mapped virtual memory circular buffers">gr_vmcircbuf</a>, or 0 if unable. </p>
<p>Call this to create a doubly mapped circular buffer. </p>
<p>Implemented in <a class="el" href="classgr__vmcircbuf__createfilemapping__factory.html#a9c26dfdb72af8766cb7073bd818b125b">gr_vmcircbuf_createfilemapping_factory</a>, <a class="el" href="classgr__vmcircbuf__mmap__shm__open__factory.html#a36d1a5b9ec8316b5c49257fada79d5f3">gr_vmcircbuf_mmap_shm_open_factory</a>, <a class="el" href="classgr__vmcircbuf__mmap__tmpfile__factory.html#a3d1ede7a9b2c35892b2237bef39a10ca">gr_vmcircbuf_mmap_tmpfile_factory</a>, and <a class="el" href="classgr__vmcircbuf__sysv__shm__factory.html#abb2c3faf0cd7b50c472c7b163aa9b177">gr_vmcircbuf_sysv_shm_factory</a>.</p>
<p>Referenced by <a class="el" href="classgr__vmcircbuf__sysconfig.html#a1c521da3ec4c80ae20fd95cde531991f">gr_vmcircbuf_sysconfig::make()</a>.</p>
</div>
</div>
<a class="anchor" id="ac8f96616c04ac03db2c5f9fa0c2d728d"></a><!-- doxytag: member="gr_vmcircbuf_factory::name" ref="ac8f96616c04ac03db2c5f9fa0c2d728d" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* gr_vmcircbuf_factory::name </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return name of this factory </p>
<p>Implemented in <a class="el" href="classgr__vmcircbuf__createfilemapping__factory.html#afebcc0ac89ace2edb8808b44f5828f53">gr_vmcircbuf_createfilemapping_factory</a>, <a class="el" href="classgr__vmcircbuf__mmap__shm__open__factory.html#a32b247e41531e9162e7c2d43ca5f0425">gr_vmcircbuf_mmap_shm_open_factory</a>, <a class="el" href="classgr__vmcircbuf__mmap__tmpfile__factory.html#a96b5bc3b5be9becb3304ebd99ff7a98f">gr_vmcircbuf_mmap_tmpfile_factory</a>, and <a class="el" href="classgr__vmcircbuf__sysv__shm__factory.html#a2d0f2257634ca1f73969fca21f477959">gr_vmcircbuf_sysv_shm_factory</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gr__vmcircbuf_8h_source.html">gr_vmcircbuf.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classgr__vmcircbuf__factory.html">gr_vmcircbuf_factory</a> </li>
<li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
2224
