<!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: ucommon::mapped_view< T > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.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 class="tabs">
<ul>
<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="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00208.html">ucommon</a>::<a class="el" href="a00076.html">mapped_view</a>
</div>
</div>
<div class="contents">
<h1>ucommon::mapped_view< T > Class Template Reference</h1><!-- doxytag: class="ucommon::mapped_view" --><!-- doxytag: inherits="ucommon::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="a00189_source.html">mapped.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucommon::mapped_view< T >:</div>
<div class="dynsection">
<div class="center"><img src="a00426.png" border="0" usemap="#ucommon_1_1mapped__view_3_01_t_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1mapped__view_3_01_t_01_4_inherit__map" id="ucommon_1_1mapped__view_3_01_t_01_4_inherit__map">
<area shape="rect" id="node2" href="a00077.html" title="Construct or access a named section of memory." alt="" coords="25,5,257,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucommon::mapped_view< T >:</div>
<div class="dynsection">
<div class="center"><img src="a00427.png" border="0" usemap="#ucommon_1_1mapped__view_3_01_t_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1mapped__view_3_01_t_01_4_coll__map" id="ucommon_1_1mapped__view_3_01_t_01_4_coll__map">
<area shape="rect" id="node2" href="a00077.html" title="Construct or access a named section of memory." alt="" coords="25,5,257,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58e9db3584c84f274e0d0cc884cb0072"></a><!-- doxytag: member="ucommon::mapped_view::copy" ref="a58e9db3584c84f274e0d0cc884cb0072" args="(unsigned member, T *buffer)" -->
void </td><td class="memItemRight" valign="bottom"><b>copy</b> (unsigned member, T *buffer)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa2f57a3eb5a22bf0f6ffaf880cbf9f83"></a><!-- doxytag: member="ucommon::mapped_view::get" ref="aa2f57a3eb5a22bf0f6ffaf880cbf9f83" args="(unsigned member)" -->
volatile const T * </td><td class="memItemRight" valign="bottom"><b>get</b> (unsigned member)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00076.html#abe2f45c0725283672ee74e2ab59c1e51">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="#abe2f45c0725283672ee74e2ab59c1e51"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00076.html#a541b01b2da49f6efa71cf0b36b4a4389">mapped_view</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Map existing named memory segment. <a href="#a541b01b2da49f6efa71cf0b36b4a4389"></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="a00076.html#a398c0d2ea99031a0c55c822582f1ea7a">operator()</a> (unsigned member)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Access typed member object in the mapped segment. <a href="#a398c0d2ea99031a0c55c822582f1ea7a"></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="a00076.html#a8c1ac0a4289447bb145b37e9aa61a168">operator[]</a> (unsigned member)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reference typed member object in the mapped segment. <a href="#a8c1ac0a4289447bb145b37e9aa61a168"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class T><br/>
class ucommon::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="a00189_source.html#l00463">463</a> of file <a class="el" href="a00189_source.html">mapped.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a541b01b2da49f6efa71cf0b36b4a4389"></a><!-- doxytag: member="ucommon::mapped_view::mapped_view" ref="a541b01b2da49f6efa71cf0b36b4a4389" 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="a00076.html">ucommon::mapped_view</a>< T >::<a class="el" href="a00076.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 border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of memory segment to map. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00189_source.html#l00471">471</a> of file <a class="el" href="a00189_source.html">mapped.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="abe2f45c0725283672ee74e2ab59c1e51"></a><!-- doxytag: member="ucommon::mapped_view::getCount" ref="abe2f45c0725283672ee74e2ab59c1e51" 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="a00076.html">ucommon::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="a00189_source.html#l00500">500</a> of file <a class="el" href="a00189_source.html">mapped.h</a>.</p>
</div>
</div>
<a class="anchor" id="a398c0d2ea99031a0c55c822582f1ea7a"></a><!-- doxytag: member="ucommon::mapped_view::operator()" ref="a398c0d2ea99031a0c55c822582f1ea7a" 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="a00076.html">ucommon::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 border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>member</em> </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="a00189_source.html#l00479">479</a> of file <a class="el" href="a00189_source.html">mapped.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8c1ac0a4289447bb145b37e9aa61a168"></a><!-- doxytag: member="ucommon::mapped_view::operator[]" ref="a8c1ac0a4289447bb145b37e9aa61a168" 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="a00076.html">ucommon::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 border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>member</em> </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="a00189_source.html#l00487">487</a> of file <a class="el" href="a00189_source.html">mapped.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00189_source.html">mapped.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:39:43 2011 for ucommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
