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.
397 Commits
6 Branches
76MB
Tree: db1e4a4e6e
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'db1e4a4e6e'
${ noResults }
DPF/classScopedPointer.html

501 lines
26KB
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:a1a88fa0865167c487050a9519297d4ed"><td class="memItemLeft" align="right" valign="top">ObjectType &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a1a88fa0865167c487050a9519297d4ed">getObject</a> () const noexcept</td></tr>

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

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

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

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

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

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

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

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

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

  102. </table>

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

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

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

  106. 

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

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

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

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

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

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

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

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

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

  116. 

  117. <div class="memitem">

  118. <div class="memproto">

  119. <div class="memtemplate">

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

  121. <table class="mlabels">

  122.   <tr>

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

  124.       <table class="memname">

  125.         <tr>

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

  127.           <td>(</td>

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

  129.           <td></td>

  130.         </tr>

  131.       </table>

  132.   </td>

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

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

  135.   </tr>

  136. </table>

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

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

  139. 

  140. </div>

  141. </div>

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

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

  144. 

  145. <div class="memitem">

  146. <div class="memproto">

  147. <div class="memtemplate">

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

  149. <table class="mlabels">

  150.   <tr>

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

  152.       <table class="memname">

  153.         <tr>

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

  155.           <td>(</td>

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

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

  158.           <td></td>

  159.         </tr>

  160.       </table>

  161.   </td>

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

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

  164.   </tr>

  165. </table>

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

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

  168. 

  169. </div>

  170. </div>

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

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

  173. 

  174. <div class="memitem">

  175. <div class="memproto">

  176. <div class="memtemplate">

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

  178. <table class="mlabels">

  179.   <tr>

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

  181.       <table class="memname">

  182.         <tr>

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

  184.           <td>(</td>

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

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

  187.           <td></td>

  188.         </tr>

  189.       </table>

  190.   </td>

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

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

  193.   </tr>

  194. </table>

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

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

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

  198. 

  199. </div>

  200. </div>

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

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

  203. 

  204. <div class="memitem">

  205. <div class="memproto">

  206. <div class="memtemplate">

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

  208. <table class="mlabels">

  209.   <tr>

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

  211.       <table class="memname">

  212.         <tr>

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

  214.           <td>(</td>

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

  216.           <td></td>

  217.         </tr>

  218.       </table>

  219.   </td>

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

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

  222.   </tr>

  223. </table>

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

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

  226. 

  227. </div>

  228. </div>

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

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

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

  232. 

  233. <div class="memitem">

  234. <div class="memproto">

  235. <div class="memtemplate">

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

  237. <table class="mlabels">

  238.   <tr>

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

  240.       <table class="memname">

  241.         <tr>

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

  243.           <td>(</td>

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

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

  246.           <td></td>

  247.         </tr>

  248.       </table>

  249.   </td>

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

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

  252.   </tr>

  253. </table>

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

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

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

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

  258. 

  259. </div>

  260. </div>

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

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

  263. 

  264. <div class="memitem">

  265. <div class="memproto">

  266. <div class="memtemplate">

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

  268. <table class="mlabels">

  269.   <tr>

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

  271.       <table class="memname">

  272.         <tr>

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

  274.           <td>(</td>

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

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

  277.           <td></td>

  278.         </tr>

  279.       </table>

  280.   </td>

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

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

  283.   </tr>

  284. </table>

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

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

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

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

  289. 

  290. </div>

  291. </div>

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

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

  294. 

  295. <div class="memitem">

  296. <div class="memproto">

  297. <div class="memtemplate">

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

  299. <table class="mlabels">

  300.   <tr>

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

  302.       <table class="memname">

  303.         <tr>

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

  305.           <td>(</td>

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

  307.           <td> const</td>

  308.         </tr>

  309.       </table>

  310.   </td>

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

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

  313.   </tr>

  314. </table>

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

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

  317. 

  318. </div>

  319. </div>

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

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

  322. 

  323. <div class="memitem">

  324. <div class="memproto">

  325. <div class="memtemplate">

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

  327. <table class="mlabels">

  328.   <tr>

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

  330.       <table class="memname">

  331.         <tr>

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

  333.           <td>(</td>

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

  335.           <td> const</td>

  336.         </tr>

  337.       </table>

  338.   </td>

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

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

  341.   </tr>

  342. </table>

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

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

  345. 

  346. </div>

  347. </div>

  348. <a id="a1a88fa0865167c487050a9519297d4ed"></a>

  349. <h2 class="memtitle"><span class="permalink"><a href="#a1a88fa0865167c487050a9519297d4ed">&#9670;&nbsp;</a></span>getObject()</h2>

  350. 

  351. <div class="memitem">

  352. <div class="memproto">

  353. <div class="memtemplate">

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

  355. <table class="mlabels">

  356.   <tr>

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

  358.       <table class="memname">

  359.         <tr>

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

  361.           <td>(</td>

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

  363.           <td> const</td>

  364.         </tr>

  365.       </table>

  366.   </td>

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

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

  369.   </tr>

  370. </table>

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

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

  373. 

  374. </div>

  375. </div>

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

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

  378. 

  379. <div class="memitem">

  380. <div class="memproto">

  381. <div class="memtemplate">

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

  383. <table class="mlabels">

  384.   <tr>

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

  386.       <table class="memname">

  387.         <tr>

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

  389.           <td>(</td>

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

  391.           <td> const</td>

  392.         </tr>

  393.       </table>

  394.   </td>

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

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

  397.   </tr>

  398. </table>

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

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

  401. 

  402. </div>

  403. </div>

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

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

  406. 

  407. <div class="memitem">

  408. <div class="memproto">

  409. <div class="memtemplate">

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

  411. <table class="mlabels">

  412.   <tr>

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

  414.       <table class="memname">

  415.         <tr>

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

  417.           <td>(</td>

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

  419.           <td> const</td>

  420.         </tr>

  421.       </table>

  422.   </td>

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

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

  425.   </tr>

  426. </table>

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

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

  429. 

  430. </div>

  431. </div>

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

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

  434. 

  435. <div class="memitem">

  436. <div class="memproto">

  437. <div class="memtemplate">

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

  439. <table class="mlabels">

  440.   <tr>

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

  442.       <table class="memname">

  443.         <tr>

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

  445.           <td>(</td>

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

  447.           <td></td>

  448.         </tr>

  449.       </table>

  450.   </td>

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

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

  453.   </tr>

  454. </table>

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

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

  457. 

  458. </div>

  459. </div>

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

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

  462. 

  463. <div class="memitem">

  464. <div class="memproto">

  465. <div class="memtemplate">

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

  467. <table class="mlabels">

  468.   <tr>

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

  470.       <table class="memname">

  471.         <tr>

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

  473.           <td>(</td>

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

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

  476.           <td></td>

  477.         </tr>

  478.       </table>

  479.   </td>

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

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

  482.   </tr>

  483. </table>

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

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

  486. 

  487. </div>

  488. </div>

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

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

  491. </ul>

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

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

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

  495. Generated on Mon Jun 14 2021 12:26:12 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  497. </a> 1.8.17

  498. </small></address>

  499. </body>

  500. </html>