<!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: memstring 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">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('a00080.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>memstring Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="memstring" --><!-- doxytag: inherits="string" -->
<p>A string class that uses a cstring buffer that is fixed in memory.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00199_source.html">string.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for memstring:</div>
<div class="dyncontent">
<div class="center"><img src="a00370.png" border="0" usemap="#memstring_inherit__map" alt="Inheritance graph"/></div>
<map name="memstring_inherit__map" id="memstring_inherit__map">
<area shape="rect" id="node7" href="a00152.html" title="A string class that has a predefined string buffer." alt="" coords="5,229,168,256"/><area shape="rect" id="node2" href="a00150.html" title="A copy-on-write string class that operates by reference count." alt="" coords="45,80,128,107"/><area shape="rect" id="node4" href="a00091.html" title="A common base class for all managed objects." alt="" coords="45,5,128,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for memstring:</div>
<div class="dyncontent">
<div class="center"><img src="a00371.png" border="0" usemap="#memstring_coll__map" alt="Collaboration graph"/></div>
<map name="memstring_coll__map" id="memstring_coll__map">
<area shape="rect" id="node2" href="a00150.html" title="A copy-on-write string class that operates by reference count." alt="" coords="20,251,103,277"/><area shape="rect" id="node4" href="a00091.html" title="A common base class for all managed objects." alt="" coords="36,5,119,32"/><area shape="rect" id="node8" href="a00037.html" title="A base class for reference counted objects." alt="" coords="80,83,232,109"/><area shape="rect" id="node6" href="a00151.html" title="This is an internal class which contains the actual string data along with some control fields..." alt="" coords="77,160,248,187"/></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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00080.html#a62fd75718019b7f23bc888b2e7a55af5">memstring</a> (void *memory, <a class="el" href="a00199.html#aac841dcc2b0fddb0c58aa1283c00ecb4">strsize_t</a> size, char fill=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an instance of a memory string. <a href="#a62fd75718019b7f23bc888b2e7a55af5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00080.html#aa3cadbda4965b2c72c813a549c6849bb">operator=</a> (const char *text)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign null terminated text to our object. <a href="#aa3cadbda4965b2c72c813a549c6849bb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00080.html#affa22886116344de7cae8e085958b204">operator=</a> (<a class="el" href="a00150.html">string</a> &object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign the text of a string to our object. <a href="#affa22886116344de7cae8e085958b204"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c0a69b2c72f7a579404b679ce85924c"></a><!-- doxytag: member="memstring::~memstring" ref="a3c0a69b2c72f7a579404b679ce85924c" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00080.html#a3c0a69b2c72f7a579404b679ce85924c">~memstring</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy memory string. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00080.html">memstring</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00080.html#aff22daf7b8151c4ab418e24d2796023b">create</a> (<a class="el" href="a00199.html#aac841dcc2b0fddb0c58aa1283c00ecb4">strsize_t</a> size, char fill=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a memory string with memory allocated from the heap. <a href="#aff22daf7b8151c4ab418e24d2796023b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00080.html">memstring</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00080.html#a7d2830630b6baef2ac04f579dec882a4">create</a> (MemoryProtocol *<a class="el" href="a00101.html">pager</a>, <a class="el" href="a00199.html#aac841dcc2b0fddb0c58aa1283c00ecb4">strsize_t</a> size, char fill=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a memory string with memory allocated from a pager. <a href="#a7d2830630b6baef2ac04f579dec882a4"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a709190f3ec293c8d861997d4a4a16ad6"></a><!-- doxytag: member="memstring::header" ref="a709190f3ec293c8d861997d4a4a16ad6" args="" -->
static const size_t </td><td class="memItemRight" valign="bottom"><b>header</b></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"><a class="el" href="a00151.html">cstring</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00080.html#ae34d826f433484a70eedc1881b5aff3d">c_copy</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return cstring to use in copy constructors. <a href="#ae34d826f433484a70eedc1881b5aff3d"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A string class that uses a cstring buffer that is fixed in memory. </p>
<p>This allows one to manipulate a fixed buffer of text in memory through the string class. The size of the memory used must include space for the overhead() size needed for the cstring object control data. </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="a00199_source.html#l01372">1372</a> of file <a class="el" href="a00199_source.html">string.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a62fd75718019b7f23bc888b2e7a55af5"></a><!-- doxytag: member="memstring::memstring" ref="a62fd75718019b7f23bc888b2e7a55af5" args="(void *memory, strsize_t size, char fill=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">memstring::memstring </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>memory</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00199.html#aac841dcc2b0fddb0c58aa1283c00ecb4">strsize_t</a> </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"><em>fill</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an instance of a memory string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">memory</td><td>to use for cstring object. </td></tr>
<tr><td class="paramname">size</td><td>of string. Total size must include space for overhead. </td></tr>
<tr><td class="paramname">fill</td><td>character for fixed character fields. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae34d826f433484a70eedc1881b5aff3d"></a><!-- doxytag: member="memstring::c_copy" ref="ae34d826f433484a70eedc1881b5aff3d" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00151.html">cstring</a>* memstring::c_copy </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return cstring to use in copy constructors. </p>
<p>Is virtual for memstring. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>cstring for copy constructor. </dd></dl>
<p>Reimplemented from <a class="el" href="a00150.html#a342941f9f257c9a3a4ea4ccb92babcb0">string</a>.</p>
</div>
</div>
<a class="anchor" id="a7d2830630b6baef2ac04f579dec882a4"></a><!-- doxytag: member="memstring::create" ref="a7d2830630b6baef2ac04f579dec882a4" args="(MemoryProtocol *pager, strsize_t size, char fill=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00080.html">memstring</a>* memstring::create </td>
<td>(</td>
<td class="paramtype">MemoryProtocol * </td>
<td class="paramname"><em>pager</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00199.html#aac841dcc2b0fddb0c58aa1283c00ecb4">strsize_t</a> </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"><em>fill</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a memory string with memory allocated from a pager. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pager</td><td>to allocate memory from. </td></tr>
<tr><td class="paramname">size</td><td>of string to allocate. Automatically adds control size. </td></tr>
<tr><td class="paramname">fill</td><td>character for fixed field strings. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aff22daf7b8151c4ab418e24d2796023b"></a><!-- doxytag: member="memstring::create" ref="aff22daf7b8151c4ab418e24d2796023b" args="(strsize_t size, char fill=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00080.html">memstring</a>* memstring::create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00199.html#aac841dcc2b0fddb0c58aa1283c00ecb4">strsize_t</a> </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"><em>fill</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a memory string with memory allocated from the heap. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>of string to allocate. Automatically adds control size. </td></tr>
<tr><td class="paramname">fill</td><td>character for fixed field strings. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa3cadbda4965b2c72c813a549c6849bb"></a><!-- doxytag: member="memstring::operator=" ref="aa3cadbda4965b2c72c813a549c6849bb" args="(const char *text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void memstring::operator= </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>text</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assign null terminated text to our object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td>to copy. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="a00150.html#a819b1e30f06209747793e1f4c89924e1">string</a>.</p>
<p>Reimplemented in <a class="el" href="a00152.html#a7c14a6a2bdf504eef316e9b07f9c16a1">stringbuf< S ></a>.</p>
<p>Definition at line <a class="el" href="a00199_source.html#l01401">1401</a> of file <a class="el" href="a00199_source.html">string.h</a>.</p>
</div>
</div>
<a class="anchor" id="affa22886116344de7cae8e085958b204"></a><!-- doxytag: member="memstring::operator=" ref="affa22886116344de7cae8e085958b204" args="(string &object)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void memstring::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00150.html">string</a> & </td>
<td class="paramname"><em>object</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assign the text of a string to our object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">object</td><td>to copy text from. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="a00152.html#a576653dcc07383ef6f4643a41c6a369e">stringbuf< S ></a>.</p>
<p>Definition at line <a class="el" href="a00199_source.html#l01394">1394</a> of file <a class="el" href="a00199_source.html">string.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00199_source.html">string.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a00080.html">memstring</a> </li>
<li class="footer">Generated on Wed Apr 13 2011 22:39:48 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>
