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.
417 Commits
7 Branches
91MB
Branch: gh-pages
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'gh-pages'
${ noResults }
DPF/classScopedPointer.html

502 lines
27KB
Raw Permalink 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.9.1"/>

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

  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','.html');

  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>Copyright (C) 2013 Raw Material Software Ltd.</p>

  108. <p>Permission is granted to use this software under the terms of the ISC license <a href="http://www.isc.org/downloads/software-support-policy/isc-license/">http://www.isc.org/downloads/software-support-policy/isc-license/</a></p>

  109. <p>Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.</p>

  110. <p>THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. This class holds a pointer which is automatically deleted when this object goes out of scope.</p>

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

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

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

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

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

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

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

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

  119. 

  120. <div class="memitem">

  121. <div class="memproto">

  122. <div class="memtemplate">

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

  124. <table class="mlabels">

  125.   <tr>

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

  127.       <table class="memname">

  128.         <tr>

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

  130.           <td>(</td>

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

  132.           <td></td>

  133.         </tr>

  134.       </table>

  135.   </td>

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

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

  138.   </tr>

  139. </table>

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

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

  142. 

  143. </div>

  144. </div>

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

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

  147. 

  148. <div class="memitem">

  149. <div class="memproto">

  150. <div class="memtemplate">

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

  152. <table class="mlabels">

  153.   <tr>

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

  155.       <table class="memname">

  156.         <tr>

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

  158.           <td>(</td>

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

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

  161.           <td></td>

  162.         </tr>

  163.       </table>

  164.   </td>

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

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

  167.   </tr>

  168. </table>

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

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

  171. 

  172. </div>

  173. </div>

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

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

  176. 

  177. <div class="memitem">

  178. <div class="memproto">

  179. <div class="memtemplate">

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

  181. <table class="mlabels">

  182.   <tr>

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

  184.       <table class="memname">

  185.         <tr>

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

  187.           <td>(</td>

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

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

  190.           <td></td>

  191.         </tr>

  192.       </table>

  193.   </td>

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

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

  196.   </tr>

  197. </table>

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

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

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

  201. 

  202. </div>

  203. </div>

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

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

  206. 

  207. <div class="memitem">

  208. <div class="memproto">

  209. <div class="memtemplate">

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

  211. <table class="mlabels">

  212.   <tr>

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

  214.       <table class="memname">

  215.         <tr>

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

  217.           <td>(</td>

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

  219.           <td></td>

  220.         </tr>

  221.       </table>

  222.   </td>

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

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

  225.   </tr>

  226. </table>

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

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

  229. 

  230. </div>

  231. </div>

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

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

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

  235. 

  236. <div class="memitem">

  237. <div class="memproto">

  238. <div class="memtemplate">

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

  240. <table class="mlabels">

  241.   <tr>

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

  243.       <table class="memname">

  244.         <tr>

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

  246.           <td>(</td>

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

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

  249.           <td></td>

  250.         </tr>

  251.       </table>

  252.   </td>

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

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

  255.   </tr>

  256. </table>

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

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

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

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

  261. 

  262. </div>

  263. </div>

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

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

  266. 

  267. <div class="memitem">

  268. <div class="memproto">

  269. <div class="memtemplate">

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

  271. <table class="mlabels">

  272.   <tr>

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

  274.       <table class="memname">

  275.         <tr>

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

  277.           <td>(</td>

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

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

  280.           <td></td>

  281.         </tr>

  282.       </table>

  283.   </td>

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

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

  286.   </tr>

  287. </table>

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

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

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

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

  292. 

  293. </div>

  294. </div>

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

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

  297. 

  298. <div class="memitem">

  299. <div class="memproto">

  300. <div class="memtemplate">

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

  302. <table class="mlabels">

  303.   <tr>

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

  305.       <table class="memname">

  306.         <tr>

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

  308.           <td>(</td>

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

  310.           <td> const</td>

  311.         </tr>

  312.       </table>

  313.   </td>

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

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

  316.   </tr>

  317. </table>

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

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

  320. 

  321. </div>

  322. </div>

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

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

  325. 

  326. <div class="memitem">

  327. <div class="memproto">

  328. <div class="memtemplate">

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

  330. <table class="mlabels">

  331.   <tr>

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

  333.       <table class="memname">

  334.         <tr>

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

  336.           <td>(</td>

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

  338.           <td> const</td>

  339.         </tr>

  340.       </table>

  341.   </td>

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

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

  344.   </tr>

  345. </table>

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

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

  348. 

  349. </div>

  350. </div>

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

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

  353. 

  354. <div class="memitem">

  355. <div class="memproto">

  356. <div class="memtemplate">

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

  358. <table class="mlabels">

  359.   <tr>

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

  361.       <table class="memname">

  362.         <tr>

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

  364.           <td>(</td>

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

  366.           <td> const</td>

  367.         </tr>

  368.       </table>

  369.   </td>

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

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

  372.   </tr>

  373. </table>

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

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

  376. 

  377. </div>

  378. </div>

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

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

  381. 

  382. <div class="memitem">

  383. <div class="memproto">

  384. <div class="memtemplate">

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

  386. <table class="mlabels">

  387.   <tr>

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

  389.       <table class="memname">

  390.         <tr>

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

  392.           <td>(</td>

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

  394.           <td> const</td>

  395.         </tr>

  396.       </table>

  397.   </td>

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

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

  400.   </tr>

  401. </table>

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

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

  404. 

  405. </div>

  406. </div>

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

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

  409. 

  410. <div class="memitem">

  411. <div class="memproto">

  412. <div class="memtemplate">

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

  414. <table class="mlabels">

  415.   <tr>

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

  417.       <table class="memname">

  418.         <tr>

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

  420.           <td>(</td>

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

  422.           <td> const</td>

  423.         </tr>

  424.       </table>

  425.   </td>

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

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

  428.   </tr>

  429. </table>

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

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

  432. 

  433. </div>

  434. </div>

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

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

  437. 

  438. <div class="memitem">

  439. <div class="memproto">

  440. <div class="memtemplate">

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

  442. <table class="mlabels">

  443.   <tr>

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

  445.       <table class="memname">

  446.         <tr>

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

  448.           <td>(</td>

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

  450.           <td></td>

  451.         </tr>

  452.       </table>

  453.   </td>

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

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

  456.   </tr>

  457. </table>

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

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

  460. 

  461. </div>

  462. </div>

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

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

  465. 

  466. <div class="memitem">

  467. <div class="memproto">

  468. <div class="memtemplate">

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

  470. <table class="mlabels">

  471.   <tr>

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

  473.       <table class="memname">

  474.         <tr>

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

  476.           <td>(</td>

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

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

  479.           <td></td>

  480.         </tr>

  481.       </table>

  482.   </td>

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

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

  485.   </tr>

  486. </table>

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

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

  489. 

  490. </div>

  491. </div>

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

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

  494. </ul>

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

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

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

  498. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1

  499. </small></address>

  500. </body>

  501. </html>