<!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: charbuf< S > 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('a00029.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>charbuf< S > Class Template Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="charbuf" -->
<p>A template to create a character array that can be manipulated as a string.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00199_source.html">string.h</a>></code></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"><a class="anchor" id="a183e0197544bd7b43702929dc93a2aa4"></a><!-- doxytag: member="charbuf::charbuf" ref="a183e0197544bd7b43702929dc93a2aa4" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#a183e0197544bd7b43702929dc93a2aa4">charbuf</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new character buffer with an empty string. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#a2609ce5c7f0151f77034293f54bd3e8d">charbuf</a> (const char *text)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a character buffer with assigned text. <a href="#a2609ce5c7f0151f77034293f54bd3e8d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#a05a0252f551b2e4357803cdfd73ca36d">operator bool</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if data is contained in the object. <a href="#a05a0252f551b2e4357803cdfd73ca36d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#aef53a0e9787645b4bc2de3fe22a0ca3d">operator char *</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get text by casting reference. <a href="#aef53a0e9787645b4bc2de3fe22a0ca3d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#a760aba07cdda31a00fc8c711ffdaf5c0">operator!</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if the object is empty. <a href="#a760aba07cdda31a00fc8c711ffdaf5c0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#ac40c66703e48eff2c5eeb3e7a5924cf7">operator()</a> (size_t offset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to an offset in the object by expression operator. <a href="#ac40c66703e48eff2c5eeb3e7a5924cf7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#a2144460eca4f98ce0f6e99bb11ced2e7">operator*</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get text by object pointer reference. <a href="#a2144460eca4f98ce0f6e99bb11ced2e7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#ad9004cf0b1a66a1bc91d7b704883bb8d">operator+=</a> (const char *text)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Concatenate text into the object. <a href="#ad9004cf0b1a66a1bc91d7b704883bb8d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#a277c8bc13f63ccfc1eafc9e4b3c0a22c">operator=</a> (const char *text)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign null terminated text to the object. <a href="#a277c8bc13f63ccfc1eafc9e4b3c0a22c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#ae094c3534f1d0173f0e7aae6c9e72bfb">operator[]</a> (size_t offset) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Array operator to get a character from the object. <a href="#ae094c3534f1d0173f0e7aae6c9e72bfb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00029.html#a5019d620420b23c36377f747f6f749a9">size</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get allocated size of the object. <a href="#a5019d620420b23c36377f747f6f749a9"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<size_t S><br/>
class charbuf< S ></h3>
<p>A template to create a character array that can be manipulated as a string. </p>
<p>This is a mini string/stringbuf class that supports a subset of functionality but does not require a complex supporting object. Like stringbuf, this can be used to create local string variables. </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#l01441">1441</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="a2609ce5c7f0151f77034293f54bd3e8d"></a><!-- doxytag: member="charbuf::charbuf" ref="a2609ce5c7f0151f77034293f54bd3e8d" args="(const char *text)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<size_t S> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00029.html">charbuf</a>< S >::<a class="el" href="a00029.html">charbuf</a> </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>Create a character buffer with assigned text. </p>
<p>If the text is larger than the size of the object, it is truncated. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td>to assign. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00199_source.html#l01458">1458</a> of file <a class="el" href="a00199_source.html">string.h</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="a00029_a2609ce5c7f0151f77034293f54bd3e8d_cgraph.png" border="0" usemap="#a00029_a2609ce5c7f0151f77034293f54bd3e8d_cgraph" alt=""/></div>
<map name="a00029_a2609ce5c7f0151f77034293f54bd3e8d_cgraph" id="a00029_a2609ce5c7f0151f77034293f54bd3e8d_cgraph">
<area shape="rect" id="node3" href="a00150.html#a01f34ab0bea03b3490de2acd15816521" title="Set string object to text of a null terminated string." alt="" coords="239,5,369,32"/></map>
</div>
</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a05a0252f551b2e4357803cdfd73ca36d"></a><!-- doxytag: member="charbuf::operator bool" ref="a05a0252f551b2e4357803cdfd73ca36d" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<size_t S> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00029.html">charbuf</a>< S >::operator bool </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Test if data is contained in the object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if there is text. </dd></dl>
<p>Definition at line <a class="el" href="a00199_source.html#l01480">1480</a> of file <a class="el" href="a00199_source.html">string.h</a>.</p>
</div>
</div>
<a class="anchor" id="aef53a0e9787645b4bc2de3fe22a0ca3d"></a><!-- doxytag: member="charbuf::operator char *" ref="aef53a0e9787645b4bc2de3fe22a0ca3d" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<size_t S> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00029.html">charbuf</a>< S >::operator char * </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get text by casting reference. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to text in object. </dd></dl>
<p>Definition at line <a class="el" href="a00199_source.html#l01494">1494</a> of file <a class="el" href="a00199_source.html">string.h</a>.</p>
</div>
</div>
<a class="anchor" id="a760aba07cdda31a00fc8c711ffdaf5c0"></a><!-- doxytag: member="charbuf::operator!" ref="a760aba07cdda31a00fc8c711ffdaf5c0" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<size_t S> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="a00029.html">charbuf</a>< S >::operator! </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Test if the object is empty. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the object is empty. </dd></dl>
<p>Definition at line <a class="el" href="a00199_source.html#l01487">1487</a> of file <a class="el" href="a00199_source.html">string.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac40c66703e48eff2c5eeb3e7a5924cf7"></a><!-- doxytag: member="charbuf::operator()" ref="ac40c66703e48eff2c5eeb3e7a5924cf7" args="(size_t offset)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<size_t S> </div>
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="a00029.html">charbuf</a>< S >::operator() </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>offset</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a pointer to an offset in the object by expression operator. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>of character in string buffer. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to offset in object. </dd></dl>
<p>Definition at line <a class="el" href="a00199_source.html#l01517">1517</a> of file <a class="el" href="a00199_source.html">string.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2144460eca4f98ce0f6e99bb11ced2e7"></a><!-- doxytag: member="charbuf::operator*" ref="a2144460eca4f98ce0f6e99bb11ced2e7" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<size_t S> </div>
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="a00029.html">charbuf</a>< S >::operator* </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get text by object pointer reference. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to text in object. </dd></dl>
<p>Definition at line <a class="el" href="a00199_source.html#l01501">1501</a> of file <a class="el" href="a00199_source.html">string.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad9004cf0b1a66a1bc91d7b704883bb8d"></a><!-- doxytag: member="charbuf::operator+=" ref="ad9004cf0b1a66a1bc91d7b704883bb8d" args="(const char *text)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<size_t S> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00029.html">charbuf</a>< S >::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>Concatenate text into the object. </p>
<p>If the text is larger than the size of the object, then it is truncated. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td>to append. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00199_source.html#l01473">1473</a> of file <a class="el" href="a00199_source.html">string.h</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="a00029_ad9004cf0b1a66a1bc91d7b704883bb8d_cgraph.png" border="0" usemap="#a00029_ad9004cf0b1a66a1bc91d7b704883bb8d_cgraph" alt=""/></div>
<map name="a00029_ad9004cf0b1a66a1bc91d7b704883bb8d_cgraph" id="a00029_ad9004cf0b1a66a1bc91d7b704883bb8d_cgraph">
<area shape="rect" id="node3" href="a00187.html#acb69ad5389c3840d5c5a88bd56912459" title="Add a linked object onto a stack of linked objects." alt="" coords="268,5,319,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a277c8bc13f63ccfc1eafc9e4b3c0a22c"></a><!-- doxytag: member="charbuf::operator=" ref="a277c8bc13f63ccfc1eafc9e4b3c0a22c" args="(const char *text)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<size_t S> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00029.html">charbuf</a>< S >::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 the object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td>to assign. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00199_source.html#l01465">1465</a> of file <a class="el" href="a00199_source.html">string.h</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="a00029_a277c8bc13f63ccfc1eafc9e4b3c0a22c_cgraph.png" border="0" usemap="#a00029_a277c8bc13f63ccfc1eafc9e4b3c0a22c_cgraph" alt=""/></div>
<map name="a00029_a277c8bc13f63ccfc1eafc9e4b3c0a22c_cgraph" id="a00029_a277c8bc13f63ccfc1eafc9e4b3c0a22c_cgraph">
<area shape="rect" id="node3" href="a00150.html#a01f34ab0bea03b3490de2acd15816521" title="Set string object to text of a null terminated string." alt="" coords="257,5,388,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ae094c3534f1d0173f0e7aae6c9e72bfb"></a><!-- doxytag: member="charbuf::operator[]" ref="ae094c3534f1d0173f0e7aae6c9e72bfb" args="(size_t offset) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<size_t S> </div>
<table class="memname">
<tr>
<td class="memname">char <a class="el" href="a00029.html">charbuf</a>< S >::operator[] </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>offset</em></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Array operator to get a character from the object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>of character in string buffer. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>character at offset. </dd></dl>
<p>Definition at line <a class="el" href="a00199_source.html#l01509">1509</a> of file <a class="el" href="a00199_source.html">string.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5019d620420b23c36377f747f6f749a9"></a><!-- doxytag: member="charbuf::size" ref="a5019d620420b23c36377f747f6f749a9" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<size_t S> </div>
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="a00029.html">charbuf</a>< S >::size </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get allocated size of the object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>allocated size. </dd></dl>
<p>Definition at line <a class="el" href="a00199_source.html#l01524">1524</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="a00029.html">charbuf</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>
