<!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::temporary< 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="a00155.html">temporary</a>
</div>
</div>
<div class="contents">
<h1>ucommon::temporary< T > Class Template Reference</h1><!-- doxytag: class="ucommon::temporary" -->
<p>Manage temporary object stored on the heap.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00186_source.html">generics.h</a>></code></p>
<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="a91ca3d9531d144a4c67703f60cb68711"></a><!-- doxytag: member="ucommon::temporary::operator bool" ref="a91ca3d9531d144a4c67703f60cb68711" args="() const " -->
</td><td class="memItemRight" valign="bottom"><b>operator bool</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8dad34fbd9bf0d090d3e175d84ab9012"></a><!-- doxytag: member="ucommon::temporary::operator!" ref="a8dad34fbd9bf0d090d3e175d84ab9012" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><b>operator!</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#a93a5d5cd1c1fbaeab2fea43c008044ae">operator*</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Access heap object through our temporary directly. <a href="#a93a5d5cd1c1fbaeab2fea43c008044ae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#a7c6c219982b9483f2980d0a5067709fb">operator-></a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Access members of our heap object through our temporary. <a href="#a7c6c219982b9483f2980d0a5067709fb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#a92c3cbca819491e215a728741bc62f5b">operator=</a> (T *temp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign a temporary object. <a href="#a92c3cbca819491e215a728741bc62f5b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#a29f9a146bed8bf30f4098615ccfad0a6">set</a> (T *temp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign a temporary object. <a href="#a29f9a146bed8bf30f4098615ccfad0a6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acaad3a23a759fc8a35e52a5d51956d17"></a><!-- doxytag: member="ucommon::temporary::temporary" ref="acaad3a23a759fc8a35e52a5d51956d17" args="(T *ptr)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#acaad3a23a759fc8a35e52a5d51956d17">temporary</a> (T *ptr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an assigned pointer. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acf66edd59b139a33427c9e34c89b93e9"></a><!-- doxytag: member="ucommon::temporary::temporary" ref="acf66edd59b139a33427c9e34c89b93e9" args="(const temporary< T > &)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#acf66edd59b139a33427c9e34c89b93e9">temporary</a> (const <a class="el" href="a00155.html">temporary</a>< T > &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disable copy constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a55cd666363d8963455cf205d2f4d26ca"></a><!-- doxytag: member="ucommon::temporary::temporary" ref="a55cd666363d8963455cf205d2f4d26ca" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00155.html#a55cd666363d8963455cf205d2f4d26ca">temporary</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a temporary object, create our stack frame reference. <br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af1be42dd24c09c207c1b5dd0a87f2501"></a><!-- doxytag: member="ucommon::temporary::object" ref="af1be42dd24c09c207c1b5dd0a87f2501" args="" -->
T * </td><td class="memItemRight" valign="bottom"><b>object</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<typename T><br/>
class ucommon::temporary< T ></h3>
<p>Manage temporary object stored on the heap. </p>
<p>This is used to create a object on the heap who's scope is controlled by the scope of a member function call. Sometimes we have data types and structures which cannot themselves appear as auto variables. We may also have a limited stack frame size in a thread context, and yet have a dynamic object that we only want to exist during the life of the method call. Using temporary allows any type to be created from the heap but have a lifespan of a method's stack frame. </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="a00186_source.html#l00259">259</a> of file <a class="el" href="a00186_source.html">generics.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a93a5d5cd1c1fbaeab2fea43c008044ae"></a><!-- doxytag: member="ucommon::temporary::operator*" ref="a93a5d5cd1c1fbaeab2fea43c008044ae" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">T& <a class="el" href="a00155.html">ucommon::temporary</a>< T >::operator* </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Access heap object through our temporary directly. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>reference to heap resident object. </dd></dl>
<p>Definition at line <a class="el" href="a00186_source.html#l00311">311</a> of file <a class="el" href="a00186_source.html">generics.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7c6c219982b9483f2980d0a5067709fb"></a><!-- doxytag: member="ucommon::temporary::operator->" ref="a7c6c219982b9483f2980d0a5067709fb" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00155.html">ucommon::temporary</a>< T >::operator-> </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Access members of our heap object through our temporary. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>member reference of heap object. </dd></dl>
<p>Definition at line <a class="el" href="a00186_source.html#l00318">318</a> of file <a class="el" href="a00186_source.html">generics.h</a>.</p>
</div>
</div>
<a class="anchor" id="a92c3cbca819491e215a728741bc62f5b"></a><!-- doxytag: member="ucommon::temporary::operator=" ref="a92c3cbca819491e215a728741bc62f5b" args="(T *temp)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">T& <a class="el" href="a00155.html">ucommon::temporary</a>< T >::operator= </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"> <em>temp</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assign a temporary object. </p>
<p>This adds a pointer to an existing type to the current temporary pointer. If the temporary was already assigned, then it is deleted. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>temp</em> </td><td>object to assign. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00186_source.html#l00288">288</a> of file <a class="el" href="a00186_source.html">generics.h</a>.</p>
</div>
</div>
<a class="anchor" id="a29f9a146bed8bf30f4098615ccfad0a6"></a><!-- doxytag: member="ucommon::temporary::set" ref="a29f9a146bed8bf30f4098615ccfad0a6" args="(T *temp)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00155.html">ucommon::temporary</a>< T >::set </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"> <em>temp</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assign a temporary object. </p>
<p>This adds a pointer to an existing type to the current temporary pointer. If the temporary was already assigned, then it is deleted. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>temp</em> </td><td>object to assign. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00186_source.html#l00301">301</a> of file <a class="el" href="a00186_source.html">generics.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00186_source.html">generics.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:40:08 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>
distrib
>
Mandriva
>
2010.2
>
i586
>
media
>
contrib-backports
>
by-pkgid
>
4f5f2dc0f55b453456458df885792b0b
>
files
>
412
