<!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>ucommon: mapped_view< T > Class Template 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">ucommon</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</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('a00074.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>mapped_view< T > Class Template Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="mapped_view" --><!-- doxytag: inherits="MappedMemory" -->
<p>Class to access a named mapped segment published from another process.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00188_source.html">mapped.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for mapped_view< T >:</div>
<div class="dyncontent">
<div class="center"><img src="a00360.png" border="0" usemap="#mapped__view_3_01_t_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="mapped__view_3_01_t_01_4_inherit__map" id="mapped__view_3_01_t_01_4_inherit__map">
<area shape="rect" id="node2" href="a00075.html" title="Construct or access a named section of memory." alt="" coords="25,5,167,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for mapped_view< T >:</div>
<div class="dyncontent">
<div class="center"><img src="a00361.png" border="0" usemap="#mapped__view_3_01_t_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="mapped__view_3_01_t_01_4_coll__map" id="mapped__view_3_01_t_01_4_coll__map">
<area shape="rect" id="node2" href="a00075.html" title="Construct or access a named section of memory." alt="" coords="25,5,167,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<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">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00074.html#aabe875f5028fd892d421754e08ded8c0">getCount</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get count of typed member objects held in this map. <a href="#aabe875f5028fd892d421754e08ded8c0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00074.html#a8d5354eecf48a97b8dd5bd2361f95ac7">mapped_view</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Map existing named memory segment. <a href="#a8d5354eecf48a97b8dd5bd2361f95ac7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">volatile const T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00074.html#a90e50f6a2cc8dae7f2cd01f02ba86d80">operator()</a> (unsigned member)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Access typed member object in the mapped segment. <a href="#a90e50f6a2cc8dae7f2cd01f02ba86d80"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">volatile const T & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00074.html#a8f65370fff7e4a3cee0f2d11948155ed">operator[]</a> (unsigned member)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reference typed member object in the mapped segment. <a href="#a8f65370fff7e4a3cee0f2d11948155ed"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<class T><br/>
class mapped_view< T ></h3>
<p>Class to access a named mapped segment published from another process. </p>
<p>This offers a simple typed vector interface to access the shared memory segment in read-only mode. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l00454">454</a> of file <a class="el" href="a00188_source.html">mapped.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8d5354eecf48a97b8dd5bd2361f95ac7"></a><!-- doxytag: member="mapped_view::mapped_view" ref="a8d5354eecf48a97b8dd5bd2361f95ac7" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00074.html">mapped_view</a>< T >::<a class="el" href="a00074.html">mapped_view</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Map existing named memory segment. </p>
<p>The size of the map is derived from the existing map alone. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>of memory segment to map. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00188_source.html#l00462">462</a> of file <a class="el" href="a00188_source.html">mapped.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aabe875f5028fd892d421754e08ded8c0"></a><!-- doxytag: member="mapped_view::getCount" ref="aabe875f5028fd892d421754e08ded8c0" args="(void)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">unsigned <a class="el" href="a00074.html">mapped_view</a>< T >::getCount </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get count of typed member objects held in this map. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>count of typed member objects. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l00485">485</a> of file <a class="el" href="a00188_source.html">mapped.h</a>.</p>
</div>
</div>
<a class="anchor" id="a90e50f6a2cc8dae7f2cd01f02ba86d80"></a><!-- doxytag: member="mapped_view::operator()" ref="a90e50f6a2cc8dae7f2cd01f02ba86d80" args="(unsigned member)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">volatile const T* <a class="el" href="a00074.html">mapped_view</a>< T >::operator() </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>member</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Access typed member object in the mapped segment. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">member</td><td>to access. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>typed object pointer. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l00470">470</a> of file <a class="el" href="a00188_source.html">mapped.h</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="a00074_a90e50f6a2cc8dae7f2cd01f02ba86d80_cgraph.png" border="0" usemap="#a00074_a90e50f6a2cc8dae7f2cd01f02ba86d80_cgraph" alt=""/></div>
<map name="a00074_a90e50f6a2cc8dae7f2cd01f02ba86d80_cgraph" id="a00074_a90e50f6a2cc8dae7f2cd01f02ba86d80_cgraph">
<area shape="rect" id="node3" href="a00075.html#a62dca2b2f5228c6b6dd533167f47cfd5" title="Get memory from a specific offset within the mapped memory segment." alt="" coords="308,5,529,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a8f65370fff7e4a3cee0f2d11948155ed"></a><!-- doxytag: member="mapped_view::operator[]" ref="a8f65370fff7e4a3cee0f2d11948155ed" args="(unsigned member)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">volatile const T& <a class="el" href="a00074.html">mapped_view</a>< T >::operator[] </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>member</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reference typed member object in the mapped segment. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">member</td><td>to access. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>typed object reference. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l00478">478</a> of file <a class="el" href="a00188_source.html">mapped.h</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="a00074_a8f65370fff7e4a3cee0f2d11948155ed_cgraph.png" border="0" usemap="#a00074_a8f65370fff7e4a3cee0f2d11948155ed_cgraph" alt=""/></div>
<map name="a00074_a8f65370fff7e4a3cee0f2d11948155ed_cgraph" id="a00074_a8f65370fff7e4a3cee0f2d11948155ed_cgraph">
<area shape="rect" id="node3" href="a00074.html#a90e50f6a2cc8dae7f2cd01f02ba86d80" title="Access typed member object in the mapped segment." alt="" coords="308,5,559,32"/><area shape="rect" id="node5" href="a00075.html#a62dca2b2f5228c6b6dd533167f47cfd5" title="Get memory from a specific offset within the mapped memory segment." alt="" coords="609,5,831,32"/></map>
</div>
</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00188_source.html">mapped.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a00074.html">mapped_view</a> </li>
<li class="footer">Generated on Wed Apr 13 2011 22:39:47 for ucommon 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>
