<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Crystal Space 1.2.1: csPtr< T > Class Template Reference (Crystal Space 1.2.1 Public API Reference)</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <table border="0" cellpadding="0" cellspacing="0" width="100%" class="head"> <tr height="59"> <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td> <td class="head"><h2>Public API Reference</h2></td> </tr> <tr height="11"> <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td> </tr> </table> <div class="content"> <!-- Generated by Doxygen 1.5.3 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="classes.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <h1>csPtr< T > Class Template Reference</h1><!-- doxytag: class="csPtr" -->A pointer encapsulator. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="ref_8h-source.html">csutil/ref.h</a>></code> <p> <p> <a href="classcsPtr-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="93be016de24aca0063e7fdff6cedfa9f"></a><!-- doxytag: member="csPtr::csPtr" ref="93be016de24aca0063e7fdff6cedfa9f" args="(const csPtr< T > &copy)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPtr.html#93be016de24aca0063e7fdff6cedfa9f">csPtr</a> (const <a class="el" href="classcsPtr.html">csPtr</a>< T > &copy)</td></tr> <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="4894925b8bf148061a157170080f052a"></a><!-- doxytag: member="csPtr::csPtr" ref="4894925b8bf148061a157170080f052a" args="(csRef< T2 > const &r)" --> template<class T2> </td></tr> <tr><td class="memTemplItemLeft" nowrap align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcsPtr.html#4894925b8bf148061a157170080f052a">csPtr</a> (<a class="el" href="classcsRef.html">csRef</a>< T2 > const &r)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5aa65124ba28b366b2f732184c87bca1"></a><!-- doxytag: member="csPtr::csPtr" ref="5aa65124ba28b366b2f732184c87bca1" args="(T *p)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPtr.html#5aa65124ba28b366b2f732184c87bca1">csPtr</a> (T *p)</td></tr> <tr><td colspan="2"><br><h2>Friends</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="acd826ace742939d758328fa03de5d4a"></a><!-- doxytag: member="csPtr::csRef< T >" ref="acd826ace742939d758328fa03de5d4a" args="" --> class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPtr.html#acd826ace742939d758328fa03de5d4a">csRef< T ></a></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> <h3>template<class T><br> class csPtr< T ></h3> A pointer encapsulator. <p> Represents a single, owned, one-time-transferable reference to an object and should be used only as the return value of a function, or when creating a brand new object which is assigned directly to a csRef<>. csPtr<> simply stores the pointer (it never invokes IncRef() or DecRef()). It is very specialized, and exists solely as a mechanism for transferring an existing reference into a csRef<>.<p> <b>Important:</b> There is only one valid way to use the result of a function which returns a csPtr<>: assign it to a csRef<>.<p> <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>An extended explanation on smart pointers - how they work and what type to use in what scenario - is contained in the User's manual, section "Correctly Using Smart Pointers". </dd></dl> <p>Definition at line <a class="el" href="ref_8h-source.html#l00085">85</a> of file <a class="el" href="ref_8h-source.html">ref.h</a>.</p> <hr>The documentation for this class was generated from the following file:<ul> <li>csutil/<a class="el" href="ref_8h-source.html">ref.h</a></ul> <hr size="1"><address><small>Generated for Crystal Space 1.2.1 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 </small></address> </div></body> </html>