DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF
1
0
Fork 0
Code Releases 0 Activity
DISTRHO Plugin Framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
389 Commits
6 Branches
59MB
Tree: 51186ba54a
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '51186ba54a'
${ noResults }
DPF/classScopedPointer.html

468 lines
25KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  2. <html xmlns="http://www.w3.org/1999/xhtml">

  3. <head>

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>

  6. <meta name="generator" content="Doxygen 1.8.13"/>

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>

  8. <title>DISTRHO Plugin Framework: ScopedPointer&lt; ObjectType &gt; Class Template Reference</title>

  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  10. <script type="text/javascript" src="jquery.js"></script>

  11. <script type="text/javascript" src="dynsections.js"></script>

  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  13. <script type="text/javascript" src="search/searchdata.js"></script>

  14. <script type="text/javascript" src="search/search.js"></script>

  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  16. </head>

  17. <body>

  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  19. <div id="titlearea">

  20. <table cellspacing="0" cellpadding="0">

  21.  <tbody>

  22.  <tr style="height: 56px;">

  23.   <td id="projectalign" style="padding-left: 0.5em;">

  24.    <div id="projectname">DISTRHO Plugin Framework

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

  31. <!-- end header part -->

  32. <!-- Generated by Doxygen 1.8.13 -->

  33. <script type="text/javascript">

  34. var searchBox = new SearchBox("searchBox", "search",false,'Search');

  35. </script>

  36. <script type="text/javascript" src="menudata.js"></script>

  37. <script type="text/javascript" src="menu.js"></script>

  38. <script type="text/javascript">

  39. $(function() {

  40.   initMenu('',true,false,'search.php','Search');

  41.   $(document).ready(function() { init_search(); });

  42. });

  43. </script>

  44. <div id="main-nav"></div>

  45. <!-- window showing the filter options -->

  46. <div id="MSearchSelectWindow"

  47.      onmouseover="return searchBox.OnSearchSelectShow()"

  48.      onmouseout="return searchBox.OnSearchSelectHide()"

  49.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  50. </div>

  51. 

  52. <!-- iframe showing the search results (closed by default) -->

  53. <div id="MSearchResultsWindow">

  54. <iframe src="javascript:void(0)" frameborder="0" 

  55.         name="MSearchResults" id="MSearchResults">

  56. </iframe>

  57. </div>

  58. 

  59. </div><!-- top -->

  60. <div class="header">

  61.   <div class="summary">

  62. <a href="#pub-methods">Public Member Functions</a> &#124;

  63. <a href="classScopedPointer-members.html">List of all members</a>  </div>

  64.   <div class="headertitle">

  65. <div class="title">ScopedPointer&lt; ObjectType &gt; Class Template Reference</div>  </div>

  66. </div><!--header-->

  67. <div class="contents">

  68. 

  69. <p><code>#include &lt;<a class="el" href="ScopedPointer_8hpp_source.html">ScopedPointer.hpp</a>&gt;</code></p>

  70. <table class="memberdecls">

  71. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>

  72. Public Member Functions</h2></td></tr>

  73. <tr class="memitem:ac187958296e33aa057dd37478ea70400"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#ac187958296e33aa057dd37478ea70400">ScopedPointer</a> () noexcept</td></tr>

  74. <tr class="separator:ac187958296e33aa057dd37478ea70400"><td class="memSeparator" colspan="2">&#160;</td></tr>

  75. <tr class="memitem:a44a7843e49c3ff719f06607b6e908f7d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a44a7843e49c3ff719f06607b6e908f7d">ScopedPointer</a> (ObjectType *const objectToTakePossessionOf) noexcept</td></tr>

  76. <tr class="separator:a44a7843e49c3ff719f06607b6e908f7d"><td class="memSeparator" colspan="2">&#160;</td></tr>

  77. <tr class="memitem:a04688b1561dd9d861ca80c6deb63a233"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a04688b1561dd9d861ca80c6deb63a233">ScopedPointer</a> (<a class="el" href="classScopedPointer.html">ScopedPointer</a> &amp;objectToTransferFrom) noexcept</td></tr>

  78. <tr class="separator:a04688b1561dd9d861ca80c6deb63a233"><td class="memSeparator" colspan="2">&#160;</td></tr>

  79. <tr class="memitem:a3c540f0121065aafa5f9607362fc1450"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a3c540f0121065aafa5f9607362fc1450">~ScopedPointer</a> ()</td></tr>

  80. <tr class="separator:a3c540f0121065aafa5f9607362fc1450"><td class="memSeparator" colspan="2">&#160;</td></tr>

  81. <tr class="memitem:afefc7940828d72c056e03804cd6bea9f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classScopedPointer.html">ScopedPointer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#afefc7940828d72c056e03804cd6bea9f">operator=</a> (<a class="el" href="classScopedPointer.html">ScopedPointer</a> &amp;objectToTransferFrom)</td></tr>

  82. <tr class="separator:afefc7940828d72c056e03804cd6bea9f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  83. <tr class="memitem:a88ee7f038e57471539d3181141c0390e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classScopedPointer.html">ScopedPointer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a88ee7f038e57471539d3181141c0390e">operator=</a> (ObjectType *const newObjectToTakePossessionOf)</td></tr>

  84. <tr class="separator:a88ee7f038e57471539d3181141c0390e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  85. <tr class="memitem:af7c241c736d79754fd6f8d305cce8bc3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#af7c241c736d79754fd6f8d305cce8bc3">operator ObjectType *</a> () const noexcept</td></tr>

  86. <tr class="separator:af7c241c736d79754fd6f8d305cce8bc3"><td class="memSeparator" colspan="2">&#160;</td></tr>

  87. <tr class="memitem:ac65fb45b9eb2d53773489fcfbc6fd740"><td class="memItemLeft" align="right" valign="top">ObjectType *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#ac65fb45b9eb2d53773489fcfbc6fd740">get</a> () const noexcept</td></tr>

  88. <tr class="separator:ac65fb45b9eb2d53773489fcfbc6fd740"><td class="memSeparator" colspan="2">&#160;</td></tr>

  89. <tr class="memitem:a2f48458a1656a6ef1bd35cb8452eed35"><td class="memItemLeft" align="right" valign="top">ObjectType &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a2f48458a1656a6ef1bd35cb8452eed35">operator*</a> () const noexcept</td></tr>

  90. <tr class="separator:a2f48458a1656a6ef1bd35cb8452eed35"><td class="memSeparator" colspan="2">&#160;</td></tr>

  91. <tr class="memitem:a6eedc84349cbe629cc1abb79ffa74e87"><td class="memItemLeft" align="right" valign="top">ObjectType *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a6eedc84349cbe629cc1abb79ffa74e87">operator-&gt;</a> () const noexcept</td></tr>

  92. <tr class="separator:a6eedc84349cbe629cc1abb79ffa74e87"><td class="memSeparator" colspan="2">&#160;</td></tr>

  93. <tr class="memitem:a10c8f696fec0cca763b067ec3e469199"><td class="memItemLeft" align="right" valign="top">ObjectType *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a10c8f696fec0cca763b067ec3e469199">release</a> () noexcept</td></tr>

  94. <tr class="separator:a10c8f696fec0cca763b067ec3e469199"><td class="memSeparator" colspan="2">&#160;</td></tr>

  95. <tr class="memitem:a362cd8d5a212df0ee08691b75a4ba3de"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a362cd8d5a212df0ee08691b75a4ba3de">swapWith</a> (<a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt; &amp;other) noexcept</td></tr>

  96. <tr class="separator:a362cd8d5a212df0ee08691b75a4ba3de"><td class="memSeparator" colspan="2">&#160;</td></tr>

  97. </table>

  98. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

  99. <div class="textblock"><h3>template&lt;class ObjectType&gt;<br />

  100. class ScopedPointer&lt; ObjectType &gt;</h3>

  101. 

  102. <p>This class holds a pointer which is automatically deleted when this object goes out of scope.</p>

  103. <p>Once a pointer has been passed to a <a class="el" href="classScopedPointer.html">ScopedPointer</a>, it will make sure that the pointer gets deleted when the <a class="el" href="classScopedPointer.html">ScopedPointer</a> is deleted. Using the <a class="el" href="classScopedPointer.html">ScopedPointer</a> on the stack or as member variables is a good way to use RAII to avoid accidentally leaking dynamically created objects.</p>

  104. <p>A <a class="el" href="classScopedPointer.html">ScopedPointer</a> can be used in pretty much the same way that you'd use a normal pointer to an object. If you use the assignment operator to assign a different object to a <a class="el" href="classScopedPointer.html">ScopedPointer</a>, the old one will be automatically deleted.</p>

  105. <p>A const <a class="el" href="classScopedPointer.html">ScopedPointer</a> is guaranteed not to lose ownership of its object or change the object to which it points during its lifetime. This means that making a copy of a const <a class="el" href="classScopedPointer.html">ScopedPointer</a> is impossible, as that would involve the new copy taking ownership from the old one.</p>

  106. <p>If you need to get a pointer out of a <a class="el" href="classScopedPointer.html">ScopedPointer</a> without it being deleted, you can use the <a class="el" href="classScopedPointer.html#a10c8f696fec0cca763b067ec3e469199">release()</a> method.</p>

  107. <p>Something to note is the main difference between this class and the std::auto_ptr class, which is that <a class="el" href="classScopedPointer.html">ScopedPointer</a> provides a cast-to-object operator, wheras std::auto_ptr requires that you always call <a class="el" href="classScopedPointer.html#ac65fb45b9eb2d53773489fcfbc6fd740">get()</a> to retrieve the pointer. The advantages of providing the cast is that you don't need to call <a class="el" href="classScopedPointer.html#ac65fb45b9eb2d53773489fcfbc6fd740">get()</a>, so can use the <a class="el" href="classScopedPointer.html">ScopedPointer</a> in pretty much exactly the same way as a raw pointer. The disadvantage is that the compiler is free to use the cast in unexpected and sometimes dangerous ways - in particular, it becomes difficult to return a <a class="el" href="classScopedPointer.html">ScopedPointer</a> as the result of a function. To avoid this causing errors, <a class="el" href="classScopedPointer.html">ScopedPointer</a> contains an overloaded constructor that should cause a syntax error in these circumstances, but it does mean that instead of returning a <a class="el" href="classScopedPointer.html">ScopedPointer</a> from a function, you'd need to return a raw pointer (or use a std::auto_ptr instead). </p>

  108. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>

  109. <a id="ac187958296e33aa057dd37478ea70400"></a>

  110. <h2 class="memtitle"><span class="permalink"><a href="#ac187958296e33aa057dd37478ea70400">&#9670;&nbsp;</a></span>ScopedPointer() <span class="overload">[1/3]</span></h2>

  111. 

  112. <div class="memitem">

  113. <div class="memproto">

  114. <div class="memtemplate">

  115. template&lt;class ObjectType&gt; </div>

  116. <table class="mlabels">

  117.   <tr>

  118.   <td class="mlabels-left">

  119.       <table class="memname">

  120.         <tr>

  121.           <td class="memname"><a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::<a class="el" href="classScopedPointer.html">ScopedPointer</a> </td>

  122.           <td>(</td>

  123.           <td class="paramname"></td><td>)</td>

  124.           <td></td>

  125.         </tr>

  126.       </table>

  127.   </td>

  128.   <td class="mlabels-right">

  129. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  130.   </tr>

  131. </table>

  132. </div><div class="memdoc">

  133. <p>Creates a <a class="el" href="classScopedPointer.html">ScopedPointer</a> containing a null pointer. </p>

  134. 

  135. </div>

  136. </div>

  137. <a id="a44a7843e49c3ff719f06607b6e908f7d"></a>

  138. <h2 class="memtitle"><span class="permalink"><a href="#a44a7843e49c3ff719f06607b6e908f7d">&#9670;&nbsp;</a></span>ScopedPointer() <span class="overload">[2/3]</span></h2>

  139. 

  140. <div class="memitem">

  141. <div class="memproto">

  142. <div class="memtemplate">

  143. template&lt;class ObjectType&gt; </div>

  144. <table class="mlabels">

  145.   <tr>

  146.   <td class="mlabels-left">

  147.       <table class="memname">

  148.         <tr>

  149.           <td class="memname"><a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::<a class="el" href="classScopedPointer.html">ScopedPointer</a> </td>

  150.           <td>(</td>

  151.           <td class="paramtype">ObjectType *const&#160;</td>

  152.           <td class="paramname"><em>objectToTakePossessionOf</em></td><td>)</td>

  153.           <td></td>

  154.         </tr>

  155.       </table>

  156.   </td>

  157.   <td class="mlabels-right">

  158. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  159.   </tr>

  160. </table>

  161. </div><div class="memdoc">

  162. <p>Creates a <a class="el" href="classScopedPointer.html">ScopedPointer</a> that owns the specified object. </p>

  163. 

  164. </div>

  165. </div>

  166. <a id="a04688b1561dd9d861ca80c6deb63a233"></a>

  167. <h2 class="memtitle"><span class="permalink"><a href="#a04688b1561dd9d861ca80c6deb63a233">&#9670;&nbsp;</a></span>ScopedPointer() <span class="overload">[3/3]</span></h2>

  168. 

  169. <div class="memitem">

  170. <div class="memproto">

  171. <div class="memtemplate">

  172. template&lt;class ObjectType&gt; </div>

  173. <table class="mlabels">

  174.   <tr>

  175.   <td class="mlabels-left">

  176.       <table class="memname">

  177.         <tr>

  178.           <td class="memname"><a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::<a class="el" href="classScopedPointer.html">ScopedPointer</a> </td>

  179.           <td>(</td>

  180.           <td class="paramtype"><a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt; &amp;&#160;</td>

  181.           <td class="paramname"><em>objectToTransferFrom</em></td><td>)</td>

  182.           <td></td>

  183.         </tr>

  184.       </table>

  185.   </td>

  186.   <td class="mlabels-right">

  187. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  188.   </tr>

  189. </table>

  190. </div><div class="memdoc">

  191. <p>Creates a <a class="el" href="classScopedPointer.html">ScopedPointer</a> that takes its pointer from another <a class="el" href="classScopedPointer.html">ScopedPointer</a>.</p>

  192. <p>Because a pointer can only belong to one <a class="el" href="classScopedPointer.html">ScopedPointer</a>, this transfers the pointer from the other object to this one, and the other object is reset to be a null pointer. </p>

  193. 

  194. </div>

  195. </div>

  196. <a id="a3c540f0121065aafa5f9607362fc1450"></a>

  197. <h2 class="memtitle"><span class="permalink"><a href="#a3c540f0121065aafa5f9607362fc1450">&#9670;&nbsp;</a></span>~ScopedPointer()</h2>

  198. 

  199. <div class="memitem">

  200. <div class="memproto">

  201. <div class="memtemplate">

  202. template&lt;class ObjectType&gt; </div>

  203. <table class="mlabels">

  204.   <tr>

  205.   <td class="mlabels-left">

  206.       <table class="memname">

  207.         <tr>

  208.           <td class="memname"><a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::~<a class="el" href="classScopedPointer.html">ScopedPointer</a> </td>

  209.           <td>(</td>

  210.           <td class="paramname"></td><td>)</td>

  211.           <td></td>

  212.         </tr>

  213.       </table>

  214.   </td>

  215.   <td class="mlabels-right">

  216. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  217.   </tr>

  218. </table>

  219. </div><div class="memdoc">

  220. <p>Destructor. This will delete the object that this <a class="el" href="classScopedPointer.html">ScopedPointer</a> currently refers to. </p>

  221. 

  222. </div>

  223. </div>

  224. <h2 class="groupheader">Member Function Documentation</h2>

  225. <a id="afefc7940828d72c056e03804cd6bea9f"></a>

  226. <h2 class="memtitle"><span class="permalink"><a href="#afefc7940828d72c056e03804cd6bea9f">&#9670;&nbsp;</a></span>operator=() <span class="overload">[1/2]</span></h2>

  227. 

  228. <div class="memitem">

  229. <div class="memproto">

  230. <div class="memtemplate">

  231. template&lt;class ObjectType&gt; </div>

  232. <table class="mlabels">

  233.   <tr>

  234.   <td class="mlabels-left">

  235.       <table class="memname">

  236.         <tr>

  237.           <td class="memname"><a class="el" href="classScopedPointer.html">ScopedPointer</a>&amp; <a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::operator= </td>

  238.           <td>(</td>

  239.           <td class="paramtype"><a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt; &amp;&#160;</td>

  240.           <td class="paramname"><em>objectToTransferFrom</em></td><td>)</td>

  241.           <td></td>

  242.         </tr>

  243.       </table>

  244.   </td>

  245.   <td class="mlabels-right">

  246. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  247.   </tr>

  248. </table>

  249. </div><div class="memdoc">

  250. <p>Changes this <a class="el" href="classScopedPointer.html">ScopedPointer</a> to point to a new object.</p>

  251. <p>Because a pointer can only belong to one <a class="el" href="classScopedPointer.html">ScopedPointer</a>, this transfers the pointer from the other object to this one, and the other object is reset to be a null pointer.</p>

  252. <p>If this <a class="el" href="classScopedPointer.html">ScopedPointer</a> already points to an object, that object will first be deleted. </p>

  253. 

  254. </div>

  255. </div>

  256. <a id="a88ee7f038e57471539d3181141c0390e"></a>

  257. <h2 class="memtitle"><span class="permalink"><a href="#a88ee7f038e57471539d3181141c0390e">&#9670;&nbsp;</a></span>operator=() <span class="overload">[2/2]</span></h2>

  258. 

  259. <div class="memitem">

  260. <div class="memproto">

  261. <div class="memtemplate">

  262. template&lt;class ObjectType&gt; </div>

  263. <table class="mlabels">

  264.   <tr>

  265.   <td class="mlabels-left">

  266.       <table class="memname">

  267.         <tr>

  268.           <td class="memname"><a class="el" href="classScopedPointer.html">ScopedPointer</a>&amp; <a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::operator= </td>

  269.           <td>(</td>

  270.           <td class="paramtype">ObjectType *const&#160;</td>

  271.           <td class="paramname"><em>newObjectToTakePossessionOf</em></td><td>)</td>

  272.           <td></td>

  273.         </tr>

  274.       </table>

  275.   </td>

  276.   <td class="mlabels-right">

  277. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  278.   </tr>

  279. </table>

  280. </div><div class="memdoc">

  281. <p>Changes this <a class="el" href="classScopedPointer.html">ScopedPointer</a> to point to a new object.</p>

  282. <p>If this <a class="el" href="classScopedPointer.html">ScopedPointer</a> already points to an object, that object will first be deleted.</p>

  283. <p>The pointer that you pass in may be a nullptr. </p>

  284. 

  285. </div>

  286. </div>

  287. <a id="af7c241c736d79754fd6f8d305cce8bc3"></a>

  288. <h2 class="memtitle"><span class="permalink"><a href="#af7c241c736d79754fd6f8d305cce8bc3">&#9670;&nbsp;</a></span>operator ObjectType *()</h2>

  289. 

  290. <div class="memitem">

  291. <div class="memproto">

  292. <div class="memtemplate">

  293. template&lt;class ObjectType&gt; </div>

  294. <table class="mlabels">

  295.   <tr>

  296.   <td class="mlabels-left">

  297.       <table class="memname">

  298.         <tr>

  299.           <td class="memname"><a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::operator ObjectType * </td>

  300.           <td>(</td>

  301.           <td class="paramname"></td><td>)</td>

  302.           <td> const</td>

  303.         </tr>

  304.       </table>

  305.   </td>

  306.   <td class="mlabels-right">

  307. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  308.   </tr>

  309. </table>

  310. </div><div class="memdoc">

  311. <p>Returns the object that this <a class="el" href="classScopedPointer.html">ScopedPointer</a> refers to. </p>

  312. 

  313. </div>

  314. </div>

  315. <a id="ac65fb45b9eb2d53773489fcfbc6fd740"></a>

  316. <h2 class="memtitle"><span class="permalink"><a href="#ac65fb45b9eb2d53773489fcfbc6fd740">&#9670;&nbsp;</a></span>get()</h2>

  317. 

  318. <div class="memitem">

  319. <div class="memproto">

  320. <div class="memtemplate">

  321. template&lt;class ObjectType&gt; </div>

  322. <table class="mlabels">

  323.   <tr>

  324.   <td class="mlabels-left">

  325.       <table class="memname">

  326.         <tr>

  327.           <td class="memname">ObjectType* <a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::get </td>

  328.           <td>(</td>

  329.           <td class="paramname"></td><td>)</td>

  330.           <td> const</td>

  331.         </tr>

  332.       </table>

  333.   </td>

  334.   <td class="mlabels-right">

  335. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  336.   </tr>

  337. </table>

  338. </div><div class="memdoc">

  339. <p>Returns the object that this <a class="el" href="classScopedPointer.html">ScopedPointer</a> refers to. </p>

  340. 

  341. </div>

  342. </div>

  343. <a id="a2f48458a1656a6ef1bd35cb8452eed35"></a>

  344. <h2 class="memtitle"><span class="permalink"><a href="#a2f48458a1656a6ef1bd35cb8452eed35">&#9670;&nbsp;</a></span>operator*()</h2>

  345. 

  346. <div class="memitem">

  347. <div class="memproto">

  348. <div class="memtemplate">

  349. template&lt;class ObjectType&gt; </div>

  350. <table class="mlabels">

  351.   <tr>

  352.   <td class="mlabels-left">

  353.       <table class="memname">

  354.         <tr>

  355.           <td class="memname">ObjectType&amp; <a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::operator* </td>

  356.           <td>(</td>

  357.           <td class="paramname"></td><td>)</td>

  358.           <td> const</td>

  359.         </tr>

  360.       </table>

  361.   </td>

  362.   <td class="mlabels-right">

  363. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  364.   </tr>

  365. </table>

  366. </div><div class="memdoc">

  367. <p>Returns the object that this <a class="el" href="classScopedPointer.html">ScopedPointer</a> refers to. </p>

  368. 

  369. </div>

  370. </div>

  371. <a id="a6eedc84349cbe629cc1abb79ffa74e87"></a>

  372. <h2 class="memtitle"><span class="permalink"><a href="#a6eedc84349cbe629cc1abb79ffa74e87">&#9670;&nbsp;</a></span>operator->()</h2>

  373. 

  374. <div class="memitem">

  375. <div class="memproto">

  376. <div class="memtemplate">

  377. template&lt;class ObjectType&gt; </div>

  378. <table class="mlabels">

  379.   <tr>

  380.   <td class="mlabels-left">

  381.       <table class="memname">

  382.         <tr>

  383.           <td class="memname">ObjectType* <a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::operator-&gt; </td>

  384.           <td>(</td>

  385.           <td class="paramname"></td><td>)</td>

  386.           <td> const</td>

  387.         </tr>

  388.       </table>

  389.   </td>

  390.   <td class="mlabels-right">

  391. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  392.   </tr>

  393. </table>

  394. </div><div class="memdoc">

  395. <p>Lets you access methods and properties of the object that this <a class="el" href="classScopedPointer.html">ScopedPointer</a> refers to. </p>

  396. 

  397. </div>

  398. </div>

  399. <a id="a10c8f696fec0cca763b067ec3e469199"></a>

  400. <h2 class="memtitle"><span class="permalink"><a href="#a10c8f696fec0cca763b067ec3e469199">&#9670;&nbsp;</a></span>release()</h2>

  401. 

  402. <div class="memitem">

  403. <div class="memproto">

  404. <div class="memtemplate">

  405. template&lt;class ObjectType&gt; </div>

  406. <table class="mlabels">

  407.   <tr>

  408.   <td class="mlabels-left">

  409.       <table class="memname">

  410.         <tr>

  411.           <td class="memname">ObjectType* <a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::release </td>

  412.           <td>(</td>

  413.           <td class="paramname"></td><td>)</td>

  414.           <td></td>

  415.         </tr>

  416.       </table>

  417.   </td>

  418.   <td class="mlabels-right">

  419. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  420.   </tr>

  421. </table>

  422. </div><div class="memdoc">

  423. <p>Removes the current object from this <a class="el" href="classScopedPointer.html">ScopedPointer</a> without deleting it. This will return the current object, and set the <a class="el" href="classScopedPointer.html">ScopedPointer</a> to a null pointer. </p>

  424. 

  425. </div>

  426. </div>

  427. <a id="a362cd8d5a212df0ee08691b75a4ba3de"></a>

  428. <h2 class="memtitle"><span class="permalink"><a href="#a362cd8d5a212df0ee08691b75a4ba3de">&#9670;&nbsp;</a></span>swapWith()</h2>

  429. 

  430. <div class="memitem">

  431. <div class="memproto">

  432. <div class="memtemplate">

  433. template&lt;class ObjectType&gt; </div>

  434. <table class="mlabels">

  435.   <tr>

  436.   <td class="mlabels-left">

  437.       <table class="memname">

  438.         <tr>

  439.           <td class="memname">void <a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::swapWith </td>

  440.           <td>(</td>

  441.           <td class="paramtype"><a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt; &amp;&#160;</td>

  442.           <td class="paramname"><em>other</em></td><td>)</td>

  443.           <td></td>

  444.         </tr>

  445.       </table>

  446.   </td>

  447.   <td class="mlabels-right">

  448. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  449.   </tr>

  450. </table>

  451. </div><div class="memdoc">

  452. <p>Swaps this object with that of another <a class="el" href="classScopedPointer.html">ScopedPointer</a>. The two objects simply exchange their pointers. </p>

  453. 

  454. </div>

  455. </div>

  456. <hr/>The documentation for this class was generated from the following file:<ul>

  457. <li>distrho/extra/<a class="el" href="ScopedPointer_8hpp_source.html">ScopedPointer.hpp</a></li>

  458. </ul>

  459. </div><!-- contents -->

  460. <!-- start footer part -->

  461. <hr class="footer"/><address class="footer"><small>

  462. Generated on Sun Apr 7 2019 05:47:58 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

  463. <img class="footer" src="doxygen.png" alt="doxygen"/>

  464. </a> 1.8.13

  465. </small></address>

  466. </body>

  467. </html>