<!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 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.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> | <a href="#pro-attribs">Protected Attributes</a> </div> <div class="headertitle"> <h1>gr_vmcircbuf Class Reference<div class="ingroups"><a class="el" href="group__internal.html">Implementation Details</a></div></h1> </div> </div> <div class="contents"> <!-- doxytag: class="gr_vmcircbuf" --> <p>abstract class to implement doubly mapped virtual memory 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:</div> <div class="dyncontent"> <div class="center"><img src="classgr__vmcircbuf__inherit__graph.png" border="0" usemap="#gr__vmcircbuf_inherit__map" alt="Inheritance graph"/></div> <map name="gr__vmcircbuf_inherit__map" id="gr__vmcircbuf_inherit__map"> <area shape="rect" id="node3" href="classgr__vmcircbuf__createfilemapping.html" title="concrete class to implement circular buffers with mmap and shm_open" alt="" coords="153,5,359,35"/><area shape="rect" id="node5" href="classgr__vmcircbuf__mmap__shm__open.html" title="concrete class to implement circular buffers with mmap and shm_open" alt="" coords="153,59,359,88"/><area shape="rect" id="node7" href="classgr__vmcircbuf__mmap__tmpfile.html" title="concrete class to implement circular buffers with mmap and shm_open" alt="" coords="163,112,349,141"/><area shape="rect" id="node9" href="classgr__vmcircbuf__sysv__shm.html" title="concrete class to implement circular buffers with mmap and shm_open" alt="" coords="175,165,337,195"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classgr__vmcircbuf-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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__vmcircbuf.html#ae00d893416c23eb6177c506af8f4f8d2">~gr_vmcircbuf</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__vmcircbuf.html#a03d4abaf899703c1b1226083982cae58">pointer_to_first_copy</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__vmcircbuf.html#a4f994ddc4c1c45b5eaa28c303af71e61">pointer_to_second_copy</a> () const </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.html#abad97351cda0ab091567e78e09fca4ed">gr_vmcircbuf</a> (int size)</td></tr> <tr><td colspan="2"><h2><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__vmcircbuf.html#a584fb274c233d5dd5f96b017ebf5003d">d_size</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__vmcircbuf.html#a87e071030553ae4121476de06e48aec4">d_base</a></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <div class="textblock"><p>abstract class to implement doubly mapped virtual memory circular buffers </p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="abad97351cda0ab091567e78e09fca4ed"></a><!-- doxytag: member="gr_vmcircbuf::gr_vmcircbuf" ref="abad97351cda0ab091567e78e09fca4ed" args="(int size)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gr_vmcircbuf::gr_vmcircbuf </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>size</em></td><td>)</td> <td><code> [inline, protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="ae00d893416c23eb6177c506af8f4f8d2"></a><!-- doxytag: member="gr_vmcircbuf::~gr_vmcircbuf" ref="ae00d893416c23eb6177c506af8f4f8d2" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual gr_vmcircbuf::~gr_vmcircbuf </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a03d4abaf899703c1b1226083982cae58"></a><!-- doxytag: member="gr_vmcircbuf::pointer_to_first_copy" ref="a03d4abaf899703c1b1226083982cae58" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void* gr_vmcircbuf::pointer_to_first_copy </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>References <a class="el" href="classgr__vmcircbuf.html#a87e071030553ae4121476de06e48aec4">d_base</a>.</p> </div> </div> <a class="anchor" id="a4f994ddc4c1c45b5eaa28c303af71e61"></a><!-- doxytag: member="gr_vmcircbuf::pointer_to_second_copy" ref="a4f994ddc4c1c45b5eaa28c303af71e61" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void* gr_vmcircbuf::pointer_to_second_copy </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>References <a class="el" href="classgr__vmcircbuf.html#a87e071030553ae4121476de06e48aec4">d_base</a>, and <a class="el" href="classgr__vmcircbuf.html#a584fb274c233d5dd5f96b017ebf5003d">d_size</a>.</p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a87e071030553ae4121476de06e48aec4"></a><!-- doxytag: member="gr_vmcircbuf::d_base" ref="a87e071030553ae4121476de06e48aec4" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">char* <a class="el" href="classgr__vmcircbuf.html#a87e071030553ae4121476de06e48aec4">gr_vmcircbuf::d_base</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Referenced by <a class="el" href="classgr__vmcircbuf.html#a03d4abaf899703c1b1226083982cae58">pointer_to_first_copy()</a>, and <a class="el" href="classgr__vmcircbuf.html#a4f994ddc4c1c45b5eaa28c303af71e61">pointer_to_second_copy()</a>.</p> </div> </div> <a class="anchor" id="a584fb274c233d5dd5f96b017ebf5003d"></a><!-- doxytag: member="gr_vmcircbuf::d_size" ref="a584fb274c233d5dd5f96b017ebf5003d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="classgr__vmcircbuf.html#a584fb274c233d5dd5f96b017ebf5003d">gr_vmcircbuf::d_size</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Referenced by <a class="el" href="classgr__vmcircbuf.html#a4f994ddc4c1c45b5eaa28c303af71e61">pointer_to_second_copy()</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.html">gr_vmcircbuf</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>