<!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::memstring Class 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="a00082.html">memstring</a>
</div>
</div>
<div class="contents">
<h1>ucommon::memstring Class Reference</h1><!-- doxytag: class="ucommon::memstring" --><!-- doxytag: inherits="ucommon::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="a00201_source.html">string.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucommon::memstring:</div>
<div class="dynsection">
<div class="center"><img src="a00436.png" border="0" usemap="#ucommon_1_1memstring_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1memstring_inherit__map" id="ucommon_1_1memstring_inherit__map">
<area shape="rect" id="node7" href="a00150.html" title="A string class that has a predefined string buffer." alt="" coords="5,229,256,256"/><area shape="rect" id="node2" href="a00148.html" title="A copy-on-write string class that operates by reference count." alt="" coords="45,80,216,107"/><area shape="rect" id="node4" href="a00095.html" title="A common base class for all managed objects." alt="" coords="5,5,256,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::memstring:</div>
<div class="dynsection">
<div class="center"><img src="a00437.png" border="0" usemap="#ucommon_1_1memstring_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1memstring_coll__map" id="ucommon_1_1memstring_coll__map">
<area shape="rect" id="node2" href="a00148.html" title="A copy-on-write string class that operates by reference count." alt="" coords="21,251,192,277"/><area shape="rect" id="node4" href="a00095.html" title="A common base class for all managed objects." alt="" coords="8,5,259,32"/><area shape="rect" id="node8" href="a00039.html" title="A base class for reference counted objects." alt="" coords="125,83,368,109"/><area shape="rect" id="node6" href="a00149.html" title="This is an internal class which contains the actual string data along with some control..." alt="" coords="123,160,384,187"/></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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#a72a3ef9ec2379a8cb75e8fc80039c50c">memstring</a> (void *memory, <a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">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="#a72a3ef9ec2379a8cb75e8fc80039c50c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#af165c21734d42507653a6ad232e0d2d3">operator=</a> (const char *text)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign null terminated text to our object. <a href="#af165c21734d42507653a6ad232e0d2d3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#ad49fd8e8dc0722359e96dd3efac4cb66">operator=</a> (<a class="el" href="a00148.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="#ad49fd8e8dc0722359e96dd3efac4cb66"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada6e1777b52878f9b18e6ebc3b9fbca7"></a><!-- doxytag: member="ucommon::memstring::~memstring" ref="ada6e1777b52878f9b18e6ebc3b9fbca7" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#ada6e1777b52878f9b18e6ebc3b9fbca7">~memstring</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy memory string. <br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00082.html">memstring</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#a3dfe57695297a8948087a575bece1ddf">create</a> (MemoryProtocol *<a class="el" href="a00103.html">pager</a>, <a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">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="#a3dfe57695297a8948087a575bece1ddf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00082.html">memstring</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#a0949b783831a3def09864948562adfce">create</a> (<a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">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="#a0949b783831a3def09864948562adfce"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a96c472205692b917df416bb36ad9efd5"></a><!-- doxytag: member="ucommon::memstring::header" ref="a96c472205692b917df416bb36ad9efd5" args="" -->
static const size_t </td><td class="memItemRight" valign="bottom"><b>header</b></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00149.html">cstring</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#aff8e0ad641d004575128aa2a3b0665ea">c_copy</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return cstring to use in copy constructors. <a href="#aff8e0ad641d004575128aa2a3b0665ea"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<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="a00201_source.html#l01421">1421</a> of file <a class="el" href="a00201_source.html">string.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a72a3ef9ec2379a8cb75e8fc80039c50c"></a><!-- doxytag: member="ucommon::memstring::memstring" ref="a72a3ef9ec2379a8cb75e8fc80039c50c" args="(void *memory, strsize_t size, char fill=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::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="a00208.html#aff28e825082cbb9ec24f288f210f34c6">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><td> </td>
</tr>
<tr>
<td></td>
<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 border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>memory</em> </td><td>to use for cstring object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of string. Total size must include space for overhead. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fill</em> </td><td>character for fixed character fields. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aff8e0ad641d004575128aa2a3b0665ea"></a><!-- doxytag: member="ucommon::memstring::c_copy" ref="aff8e0ad641d004575128aa2a3b0665ea" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00149.html">cstring</a>* ucommon::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="a00148.html#a20c58f46753026bf166ea90dc9b6d6ea">ucommon::string</a>.</p>
</div>
</div>
<a class="anchor" id="a3dfe57695297a8948087a575bece1ddf"></a><!-- doxytag: member="ucommon::memstring::create" ref="a3dfe57695297a8948087a575bece1ddf" 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="a00082.html">memstring</a>* ucommon::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="a00208.html#aff28e825082cbb9ec24f288f210f34c6">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><td> </td>
</tr>
<tr>
<td></td>
<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 border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pager</em> </td><td>to allocate memory from. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of string to allocate. Automatically adds control size. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fill</em> </td><td>character for fixed field strings. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0949b783831a3def09864948562adfce"></a><!-- doxytag: member="ucommon::memstring::create" ref="a0949b783831a3def09864948562adfce" 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="a00082.html">memstring</a>* ucommon::memstring::create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">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><td> </td>
</tr>
<tr>
<td></td>
<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 border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of string to allocate. Automatically adds control size. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fill</em> </td><td>character for fixed field strings. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af165c21734d42507653a6ad232e0d2d3"></a><!-- doxytag: member="ucommon::memstring::operator=" ref="af165c21734d42507653a6ad232e0d2d3" args="(const char *text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::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 border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>to copy. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="a00148.html#a25b1611be64125a1cb119ff48fc3fc3e">ucommon::string</a>.</p>
<p>Reimplemented in <a class="el" href="a00150.html#a211b2ec3930328424edf36c7e3fb6106">ucommon::stringbuf< S ></a>.</p>
<p>Definition at line <a class="el" href="a00201_source.html#l01450">1450</a> of file <a class="el" href="a00201_source.html">string.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad49fd8e8dc0722359e96dd3efac4cb66"></a><!-- doxytag: member="ucommon::memstring::operator=" ref="ad49fd8e8dc0722359e96dd3efac4cb66" args="(string &object)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::memstring::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00148.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 border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>to copy text from. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="a00150.html#a9dc442c64243adbad0593c9fc40055f2">ucommon::stringbuf< S ></a>.</p>
<p>Definition at line <a class="el" href="a00201_source.html#l01443">1443</a> of file <a class="el" href="a00201_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="a00201_source.html">string.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:39:45 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>
