<!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.h Source File</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('gr__vmcircbuf_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>gr_vmcircbuf.h</h1> </div>
</div>
<div class="contents">
<a href="gr__vmcircbuf_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2003 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> * </span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span>
<a name="l00006"></a>00006 <span class="comment"> * </span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> * </span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> * </span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span>
<a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span>
<a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef _GR_VMCIRCBUF_H_</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define _GR_VMCIRCBUF_H_</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <vector></span>
<a name="l00027"></a>00027 <span class="comment"></span>
<a name="l00028"></a>00028 <span class="comment">/*!</span>
<a name="l00029"></a>00029 <span class="comment"> * \brief abstract class to implement doubly mapped virtual memory circular buffers</span>
<a name="l00030"></a>00030 <span class="comment"> * \ingroup internal</span>
<a name="l00031"></a>00031 <span class="comment"> */</span>
<a name="l00032"></a><a class="code" href="classgr__vmcircbuf.html">00032</a> <span class="keyword">class </span><a class="code" href="classgr__vmcircbuf.html" title="abstract class to implement doubly mapped virtual memory circular buffers">gr_vmcircbuf</a> {
<a name="l00033"></a>00033 <span class="keyword">protected</span>:
<a name="l00034"></a><a class="code" href="classgr__vmcircbuf.html#a584fb274c233d5dd5f96b017ebf5003d">00034</a> <span class="keywordtype">int</span> <a class="code" href="classgr__vmcircbuf.html#a584fb274c233d5dd5f96b017ebf5003d">d_size</a>;
<a name="l00035"></a><a class="code" href="classgr__vmcircbuf.html#a87e071030553ae4121476de06e48aec4">00035</a> <span class="keywordtype">char</span> *<a class="code" href="classgr__vmcircbuf.html#a87e071030553ae4121476de06e48aec4">d_base</a>;
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="comment">// CREATORS</span>
<a name="l00038"></a><a class="code" href="classgr__vmcircbuf.html#abad97351cda0ab091567e78e09fca4ed">00038</a> <a class="code" href="classgr__vmcircbuf.html#abad97351cda0ab091567e78e09fca4ed">gr_vmcircbuf</a> (<span class="keywordtype">int</span> size) : <a class="code" href="classgr__vmcircbuf.html#a584fb274c233d5dd5f96b017ebf5003d">d_size</a> (size), <a class="code" href="classgr__vmcircbuf.html#a87e071030553ae4121476de06e48aec4">d_base</a> (0) {};
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="keyword">public</span>:
<a name="l00041"></a>00041 <span class="keyword">virtual</span> <a class="code" href="classgr__vmcircbuf.html#ae00d893416c23eb6177c506af8f4f8d2">~gr_vmcircbuf</a> ();
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="comment">// ACCESSORS</span>
<a name="l00044"></a><a class="code" href="classgr__vmcircbuf.html#a03d4abaf899703c1b1226083982cae58">00044</a> <span class="keywordtype">void</span> *<a class="code" href="classgr__vmcircbuf.html#a03d4abaf899703c1b1226083982cae58">pointer_to_first_copy</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classgr__vmcircbuf.html#a87e071030553ae4121476de06e48aec4">d_base</a>; }
<a name="l00045"></a><a class="code" href="classgr__vmcircbuf.html#a4f994ddc4c1c45b5eaa28c303af71e61">00045</a> <span class="keywordtype">void</span> *<a class="code" href="classgr__vmcircbuf.html#a4f994ddc4c1c45b5eaa28c303af71e61">pointer_to_second_copy</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classgr__vmcircbuf.html#a87e071030553ae4121476de06e48aec4">d_base</a> + <a class="code" href="classgr__vmcircbuf.html#a584fb274c233d5dd5f96b017ebf5003d">d_size</a>; }
<a name="l00046"></a>00046 };
<a name="l00047"></a>00047 <span class="comment"></span>
<a name="l00048"></a>00048 <span class="comment">/*!</span>
<a name="l00049"></a>00049 <span class="comment"> * \brief abstract factory for creating circular buffers</span>
<a name="l00050"></a>00050 <span class="comment"> */</span>
<a name="l00051"></a><a class="code" href="classgr__vmcircbuf__factory.html">00051</a> <span class="keyword">class </span><a class="code" href="classgr__vmcircbuf__factory.html" title="abstract factory for creating circular buffers">gr_vmcircbuf_factory</a> {
<a name="l00052"></a>00052 <span class="keyword">protected</span>:
<a name="l00053"></a><a class="code" href="classgr__vmcircbuf__factory.html#a5d08857f4d2c09b0bd027963cf904a10">00053</a> <a class="code" href="classgr__vmcircbuf__factory.html#a5d08857f4d2c09b0bd027963cf904a10">gr_vmcircbuf_factory</a> () {};
<a name="l00054"></a>00054 <span class="keyword">virtual</span> <a class="code" href="classgr__vmcircbuf__factory.html#af7b1bc5f8cf80eadd8f771a8931e10cf">~gr_vmcircbuf_factory</a> ();
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="keyword">public</span>:
<a name="l00057"></a>00057 <span class="comment"></span>
<a name="l00058"></a>00058 <span class="comment"> /*!</span>
<a name="l00059"></a>00059 <span class="comment"> * \brief return name of this factory</span>
<a name="l00060"></a>00060 <span class="comment"> */</span>
<a name="l00061"></a>00061 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classgr__vmcircbuf__factory.html#ac8f96616c04ac03db2c5f9fa0c2d728d" title="return name of this factory">name</a> () <span class="keyword">const</span> = 0;
<a name="l00062"></a>00062 <span class="comment"></span>
<a name="l00063"></a>00063 <span class="comment"> /*!</span>
<a name="l00064"></a>00064 <span class="comment"> * \brief return granularity of mapping, typically equal to page size</span>
<a name="l00065"></a>00065 <span class="comment"> */</span>
<a name="l00066"></a>00066 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classgr__vmcircbuf__factory.html#a1e6730e738aef0a4164538ce8bcf5e8d" title="return granularity of mapping, typically equal to page size">granularity</a> () = 0;
<a name="l00067"></a>00067 <span class="comment"></span>
<a name="l00068"></a>00068 <span class="comment"> /*!</span>
<a name="l00069"></a>00069 <span class="comment"> * \brief return a gr_vmcircbuf, or 0 if unable.</span>
<a name="l00070"></a>00070 <span class="comment"> *</span>
<a name="l00071"></a>00071 <span class="comment"> * Call this to create a doubly mapped circular buffer.</span>
<a name="l00072"></a>00072 <span class="comment"> */</span>
<a name="l00073"></a>00073 <span class="keyword">virtual</span> <a class="code" href="classgr__vmcircbuf.html" title="abstract class to implement doubly mapped virtual memory circular buffers">gr_vmcircbuf</a> *<a class="code" href="classgr__vmcircbuf__factory.html#a93e1d9a839a9edc332e1b7b9eb594293" title="return a gr_vmcircbuf, or 0 if unable.">make</a> (<span class="keywordtype">int</span> size) = 0;
<a name="l00074"></a>00074 };
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="comment">/*</span>
<a name="l00077"></a>00077 <span class="comment"> * \brief pulls together all implementations of gr_vmcircbuf</span>
<a name="l00078"></a>00078 <span class="comment"> */</span>
<a name="l00079"></a><a class="code" href="classgr__vmcircbuf__sysconfig.html">00079</a> <span class="keyword">class </span><a class="code" href="classgr__vmcircbuf__sysconfig.html">gr_vmcircbuf_sysconfig</a> {
<a name="l00080"></a>00080 <span class="keyword">public</span>:
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="comment">/*</span>
<a name="l00083"></a>00083 <span class="comment"> * \brief return the single instance of the default factory.</span>
<a name="l00084"></a>00084 <span class="comment"> *</span>
<a name="l00085"></a>00085 <span class="comment"> * returns the default factory to use if it's already defined,</span>
<a name="l00086"></a>00086 <span class="comment"> * else find the first working factory and use it.</span>
<a name="l00087"></a>00087 <span class="comment"> */</span>
<a name="l00088"></a>00088 <span class="keyword">static</span> <a class="code" href="classgr__vmcircbuf__factory.html" title="abstract factory for creating circular buffers">gr_vmcircbuf_factory</a> *<a class="code" href="classgr__vmcircbuf__sysconfig.html#a8e72c9320c2fe9d1e6a4f9ce8a28cc58">get_default_factory</a> ();
<a name="l00089"></a>00089
<a name="l00090"></a>00090
<a name="l00091"></a><a class="code" href="classgr__vmcircbuf__sysconfig.html#aaae9e70d8b158d2e22b64c8ad283dbaa">00091</a> <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="classgr__vmcircbuf__sysconfig.html#aaae9e70d8b158d2e22b64c8ad283dbaa">granularity</a> () { <span class="keywordflow">return</span> <a class="code" href="classgr__vmcircbuf__sysconfig.html#a8e72c9320c2fe9d1e6a4f9ce8a28cc58">get_default_factory</a>()-><a class="code" href="classgr__vmcircbuf__factory.html#a1e6730e738aef0a4164538ce8bcf5e8d" title="return granularity of mapping, typically equal to page size">granularity</a>(); }
<a name="l00092"></a><a class="code" href="classgr__vmcircbuf__sysconfig.html#a1c521da3ec4c80ae20fd95cde531991f">00092</a> <span class="keyword">static</span> <a class="code" href="classgr__vmcircbuf.html" title="abstract class to implement doubly mapped virtual memory circular buffers">gr_vmcircbuf</a> *<a class="code" href="classgr__vmcircbuf__sysconfig.html#a1c521da3ec4c80ae20fd95cde531991f">make</a> (<span class="keywordtype">int</span> size) { <span class="keywordflow">return</span> <a class="code" href="classgr__vmcircbuf__sysconfig.html#a8e72c9320c2fe9d1e6a4f9ce8a28cc58">get_default_factory</a>()-><a class="code" href="classgr__vmcircbuf__factory.html#a93e1d9a839a9edc332e1b7b9eb594293" title="return a gr_vmcircbuf, or 0 if unable.">make</a>(size); }
<a name="l00093"></a>00093
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="comment">// N.B. not all factories are guaranteed to work.</span>
<a name="l00096"></a>00096 <span class="comment">// It's too hard to check everything at config time, so we check at runtime</span>
<a name="l00097"></a>00097 <span class="keyword">static</span> <a class="code" href="classstd_1_1vector.html" title="vector documentation stub">std::vector<gr_vmcircbuf_factory *></a> <a class="code" href="classgr__vmcircbuf__sysconfig.html#ae6b153e2b6b8599cee6fcb65ad62fc48">all_factories</a> ();
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="comment">// make this factory the default</span>
<a name="l00100"></a>00100 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classgr__vmcircbuf__sysconfig.html#a8d6e740877362ca36487bff1bcc8f4b0">set_default_factory</a> (<a class="code" href="classgr__vmcircbuf__factory.html" title="abstract factory for creating circular buffers">gr_vmcircbuf_factory</a> *f);
<a name="l00101"></a>00101 <span class="comment"></span>
<a name="l00102"></a>00102 <span class="comment"> /*!</span>
<a name="l00103"></a>00103 <span class="comment"> * \brief Does this factory really work?</span>
<a name="l00104"></a>00104 <span class="comment"> *</span>
<a name="l00105"></a>00105 <span class="comment"> * verbose = 0: silent</span>
<a name="l00106"></a>00106 <span class="comment"> * verbose = 1: names of factories tested and results</span>
<a name="l00107"></a>00107 <span class="comment"> * verbose = 2: all intermediate results</span>
<a name="l00108"></a>00108 <span class="comment"> */</span>
<a name="l00109"></a>00109 <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classgr__vmcircbuf__sysconfig.html#aaedb9ef81947bc49f3d5f33c006301d3" title="Does this factory really work?">test_factory</a> (<a class="code" href="classgr__vmcircbuf__factory.html" title="abstract factory for creating circular buffers">gr_vmcircbuf_factory</a> *f, <span class="keywordtype">int</span> verbose);
<a name="l00110"></a>00110 <span class="comment"></span>
<a name="l00111"></a>00111 <span class="comment"> /*!</span>
<a name="l00112"></a>00112 <span class="comment"> * \brief Test all factories, return true if at least one of them works</span>
<a name="l00113"></a>00113 <span class="comment"> * verbose = 0: silent</span>
<a name="l00114"></a>00114 <span class="comment"> * verbose = 1: names of factories tested and results</span>
<a name="l00115"></a>00115 <span class="comment"> * verbose = 2: all intermediate results</span>
<a name="l00116"></a>00116 <span class="comment"> */</span>
<a name="l00117"></a>00117 <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classgr__vmcircbuf__sysconfig.html#a30ac25651fb37b9c10a6160f5e7f0d69" title="Test all factories, return true if at least one of them works verbose = 0: silent verbose = 1: names ...">test_all_factories</a> (<span class="keywordtype">int</span> verbose);
<a name="l00118"></a>00118 };
<a name="l00119"></a>00119
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="preprocessor">#endif </span><span class="comment">/* _GR_VMCIRCBUF_H_ */</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="gr__vmcircbuf_8h.html">gr_vmcircbuf.h</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
>
5507
