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.
395 Commits
7 Branches
79MB
Tree: 69059836fe
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '69059836fe'
${ noResults }
DPF/classScopedPointer.html

471 lines
25KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>

  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.17 -->

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

  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

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

  36. /* @license-end */

  37. </script>

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

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

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

  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  42. $(function() {

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

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

  45. });

  46. /* @license-end */</script>

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

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

  49. <div id="MSearchSelectWindow"

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

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

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

  53. </div>

  54. 

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

  56. <div id="MSearchResultsWindow">

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

  58.         name="MSearchResults" id="MSearchResults">

  59. </iframe>

  60. </div>

  61. 

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

  63. <div class="header">

  64.   <div class="summary">

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

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

  67.   <div class="headertitle">

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

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

  70. <div class="contents">

  71. 

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

  73. <table class="memberdecls">

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

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

  76. <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>

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

  78. <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>

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

  80. <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>

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

  82. <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>

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

  84. <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>

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

  86. <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>

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

  88. <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>

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

  90. <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>

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

  92. <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>

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

  94. <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>

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

  96. <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>

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

  98. <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>

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

  100. </table>

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

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

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

  104. 

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

  106. <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>

  107. <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>

  108. <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>

  109. <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>

  110. <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>

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

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

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

  114. 

  115. <div class="memitem">

  116. <div class="memproto">

  117. <div class="memtemplate">

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

  119. <table class="mlabels">

  120.   <tr>

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

  122.       <table class="memname">

  123.         <tr>

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

  125.           <td>(</td>

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

  127.           <td></td>

  128.         </tr>

  129.       </table>

  130.   </td>

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

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

  133.   </tr>

  134. </table>

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

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

  137. 

  138. </div>

  139. </div>

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

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

  142. 

  143. <div class="memitem">

  144. <div class="memproto">

  145. <div class="memtemplate">

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

  147. <table class="mlabels">

  148.   <tr>

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

  150.       <table class="memname">

  151.         <tr>

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

  153.           <td>(</td>

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

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

  156.           <td></td>

  157.         </tr>

  158.       </table>

  159.   </td>

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

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

  162.   </tr>

  163. </table>

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

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

  166. 

  167. </div>

  168. </div>

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

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

  171. 

  172. <div class="memitem">

  173. <div class="memproto">

  174. <div class="memtemplate">

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

  176. <table class="mlabels">

  177.   <tr>

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

  179.       <table class="memname">

  180.         <tr>

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

  182.           <td>(</td>

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

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

  185.           <td></td>

  186.         </tr>

  187.       </table>

  188.   </td>

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

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

  191.   </tr>

  192. </table>

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

  194. <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>

  195. <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>

  196. 

  197. </div>

  198. </div>

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

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

  201. 

  202. <div class="memitem">

  203. <div class="memproto">

  204. <div class="memtemplate">

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

  206. <table class="mlabels">

  207.   <tr>

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

  209.       <table class="memname">

  210.         <tr>

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

  212.           <td>(</td>

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

  214.           <td></td>

  215.         </tr>

  216.       </table>

  217.   </td>

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

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

  220.   </tr>

  221. </table>

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

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

  224. 

  225. </div>

  226. </div>

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

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

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

  230. 

  231. <div class="memitem">

  232. <div class="memproto">

  233. <div class="memtemplate">

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

  235. <table class="mlabels">

  236.   <tr>

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

  238.       <table class="memname">

  239.         <tr>

  240.           <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>

  241.           <td>(</td>

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

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

  244.           <td></td>

  245.         </tr>

  246.       </table>

  247.   </td>

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

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

  250.   </tr>

  251. </table>

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

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

  254. <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>

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

  256. 

  257. </div>

  258. </div>

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

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

  261. 

  262. <div class="memitem">

  263. <div class="memproto">

  264. <div class="memtemplate">

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

  266. <table class="mlabels">

  267.   <tr>

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

  269.       <table class="memname">

  270.         <tr>

  271.           <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>

  272.           <td>(</td>

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

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

  275.           <td></td>

  276.         </tr>

  277.       </table>

  278.   </td>

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

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

  281.   </tr>

  282. </table>

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

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

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

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

  287. 

  288. </div>

  289. </div>

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

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

  292. 

  293. <div class="memitem">

  294. <div class="memproto">

  295. <div class="memtemplate">

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

  297. <table class="mlabels">

  298.   <tr>

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

  300.       <table class="memname">

  301.         <tr>

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

  303.           <td>(</td>

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

  305.           <td> const</td>

  306.         </tr>

  307.       </table>

  308.   </td>

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

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

  311.   </tr>

  312. </table>

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

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

  315. 

  316. </div>

  317. </div>

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

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

  320. 

  321. <div class="memitem">

  322. <div class="memproto">

  323. <div class="memtemplate">

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

  325. <table class="mlabels">

  326.   <tr>

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

  328.       <table class="memname">

  329.         <tr>

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

  331.           <td>(</td>

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

  333.           <td> const</td>

  334.         </tr>

  335.       </table>

  336.   </td>

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

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

  339.   </tr>

  340. </table>

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

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

  343. 

  344. </div>

  345. </div>

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

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

  348. 

  349. <div class="memitem">

  350. <div class="memproto">

  351. <div class="memtemplate">

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

  353. <table class="mlabels">

  354.   <tr>

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

  356.       <table class="memname">

  357.         <tr>

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

  359.           <td>(</td>

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

  361.           <td> const</td>

  362.         </tr>

  363.       </table>

  364.   </td>

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

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

  367.   </tr>

  368. </table>

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

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

  371. 

  372. </div>

  373. </div>

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

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

  376. 

  377. <div class="memitem">

  378. <div class="memproto">

  379. <div class="memtemplate">

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

  381. <table class="mlabels">

  382.   <tr>

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

  384.       <table class="memname">

  385.         <tr>

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

  387.           <td>(</td>

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

  389.           <td> const</td>

  390.         </tr>

  391.       </table>

  392.   </td>

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

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

  395.   </tr>

  396. </table>

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

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

  399. 

  400. </div>

  401. </div>

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

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

  404. 

  405. <div class="memitem">

  406. <div class="memproto">

  407. <div class="memtemplate">

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

  409. <table class="mlabels">

  410.   <tr>

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

  412.       <table class="memname">

  413.         <tr>

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

  415.           <td>(</td>

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

  417.           <td></td>

  418.         </tr>

  419.       </table>

  420.   </td>

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

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

  423.   </tr>

  424. </table>

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

  426. <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>

  427. 

  428. </div>

  429. </div>

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

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

  432. 

  433. <div class="memitem">

  434. <div class="memproto">

  435. <div class="memtemplate">

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

  437. <table class="mlabels">

  438.   <tr>

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

  440.       <table class="memname">

  441.         <tr>

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

  443.           <td>(</td>

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

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

  446.           <td></td>

  447.         </tr>

  448.       </table>

  449.   </td>

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

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

  452.   </tr>

  453. </table>

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

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

  456. 

  457. </div>

  458. </div>

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

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

  461. </ul>

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

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

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

  465. Generated on Tue May 18 2021 11:21:12 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  467. </a> 1.8.17

  468. </small></address>

  469. </body>

  470. </html>