<!-- HTML header for doxygen 1.8.8-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<!-- For Mobile Devices -->
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<script type="text/javascript" src="jquery.min.js"></script>
<title>rttr: rttr::destructor Class Reference</title>
<!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
<script type="text/javascript" src="dynsections.js"></script>
<link rel = "shortcut icon" type = "image/x-icon" href = "favicon.ico">
<link rel = "stylesheet" href = "fonts/ptsans_regular_macroman/stylesheet.css">
<link rel = "stylesheet" href = "fonts/source_code_pro_regular/stylesheet.css">
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="custom-doxygen.css" rel="stylesheet" type="text/css"/>
<link rel="stylesheet" href="bootstrap/css/bootstrap.min.css">
<link rel="stylesheet" href="custom-bootstrap.css">
<script src="bootstrap/js/bootstrap.min.js"></script>
<script type="text/javascript" src="doxy-boot.js"></script>
</head>
<body>
<!--
<nav class="navbar navbar-default" role="navigation">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand">rttr 0.9.6</a>
</div>
</div>
</nav>
-->
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div class="content" id="content">
<div class="container">
<div class="row">
<div class="col-sm-12 panel panel-default" style="padding-bottom: 15px;">
<div style="margin-bottom: 15px;">
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacerttr.html">rttr</a></li><li class="navelem"><a class="el" href="classrttr_1_1destructor.html">destructor</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classrttr_1_1destructor-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">rttr::destructor Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="classrttr_1_1destructor.html">destructor</a> class provides a destructor for registered types.
<a href="classrttr_1_1destructor.html#details">More...</a></p>
<p><code>#include <<a class="el" href="destructor_8h_source.html">destructor.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0b8c6489f17d40c7a221d833d8b8b85e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classrttr_1_1type.html">type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1destructor.html#a0b8c6489f17d40c7a221d833d8b8b85e">get_declaring_type</a> () const noexcept</td></tr>
<tr class="memdesc:a0b8c6489f17d40c7a221d833d8b8b85e"><td class="mdescLeft"> </td><td class="mdescRight">Returns the class that declares this destructor. <a href="#a0b8c6489f17d40c7a221d833d8b8b85e">More...</a><br /></td></tr>
<tr class="separator:a0b8c6489f17d40c7a221d833d8b8b85e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f6257216d80cac7eea9fc9b33df44d1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classrttr_1_1type.html">type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1destructor.html#a5f6257216d80cac7eea9fc9b33df44d1">get_destructed_type</a> () const noexcept</td></tr>
<tr class="memdesc:a5f6257216d80cac7eea9fc9b33df44d1"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="classrttr_1_1type.html" title="The type class holds the type information for any arbitrary object.">rttr::type</a> for which this destructor can delete objects. <a href="#a5f6257216d80cac7eea9fc9b33df44d1">More...</a><br /></td></tr>
<tr class="separator:a5f6257216d80cac7eea9fc9b33df44d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a93d528bf4496174e7ab046dc714b2846"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1destructor.html#a93d528bf4496174e7ab046dc714b2846">invoke</a> (<a class="el" href="classrttr_1_1variant.html">variant</a> &obj) const noexcept</td></tr>
<tr class="memdesc:a93d528bf4496174e7ab046dc714b2846"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the contained object in the variant <code>obj</code>. <a href="#a93d528bf4496174e7ab046dc714b2846">More...</a><br /></td></tr>
<tr class="separator:a93d528bf4496174e7ab046dc714b2846"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad90bf497e9201c974341cc8756a19112"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1destructor.html#ad90bf497e9201c974341cc8756a19112">is_valid</a> () const noexcept</td></tr>
<tr class="memdesc:ad90bf497e9201c974341cc8756a19112"><td class="mdescLeft"> </td><td class="mdescRight">Returns true whether this destructor object is valid; otherwise false. <a href="#ad90bf497e9201c974341cc8756a19112">More...</a><br /></td></tr>
<tr class="separator:ad90bf497e9201c974341cc8756a19112"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55910565530b9f3a6e16e994ffa82ddc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1destructor.html#a55910565530b9f3a6e16e994ffa82ddc">operator bool</a> () const noexcept</td></tr>
<tr class="memdesc:a55910565530b9f3a6e16e994ffa82ddc"><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to check if this destructor is valid or not. <a href="#a55910565530b9f3a6e16e994ffa82ddc">More...</a><br /></td></tr>
<tr class="separator:a55910565530b9f3a6e16e994ffa82ddc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aca5703f168a59592322d326a98d62547"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1destructor.html#aca5703f168a59592322d326a98d62547">operator!=</a> (const <a class="el" href="classrttr_1_1destructor.html">destructor</a> &other) const noexcept</td></tr>
<tr class="memdesc:aca5703f168a59592322d326a98d62547"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this destructor is the not the same like the <code>other</code>. <a href="#aca5703f168a59592322d326a98d62547">More...</a><br /></td></tr>
<tr class="separator:aca5703f168a59592322d326a98d62547"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab6018f6fd87d3a4075d5f3703ab87948"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1destructor.html#ab6018f6fd87d3a4075d5f3703ab87948">operator==</a> (const <a class="el" href="classrttr_1_1destructor.html">destructor</a> &other) const noexcept</td></tr>
<tr class="memdesc:ab6018f6fd87d3a4075d5f3703ab87948"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this destructor is the same like the <code>other</code>. <a href="#ab6018f6fd87d3a4075d5f3703ab87948">More...</a><br /></td></tr>
<tr class="separator:ab6018f6fd87d3a4075d5f3703ab87948"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classrttr_1_1destructor.html">destructor</a> class provides a destructor for registered types. </p>
<p>A instance of a destructor class can only be obtained from the <a class="el" href="classrttr_1_1type.html">type</a> class. See <a class="el" href="classrttr_1_1type.html#a12d900648f71d11873896f58b1f9a3ac">type::get_destructor()</a>.</p>
<h2>Copying and Assignment </h2>
<p>A <a class="el" href="classrttr_1_1destructor.html">destructor</a> object is lightweight and can be copied by value. However, each copy will refer to the same underlying destructor.</p>
<h2>Typical Usage </h2>
<div class="fragment"><div class="line">constructor string_ctor == <a class="code" href="classrttr_1_1type.html#a7ba79b9f4916c30db74fe65508dca033">type::get_by_name</a>(<span class="stringliteral">"std::string"</span>).<a class="code" href="classrttr_1_1type.html#ae1ed385e76752e7c02ffd9bf5a0ae410">get_constructor</a>({type::get<const char*>()});</div><div class="line"></div><div class="line">variant my_string = string_ctor.<a class="code" href="classrttr_1_1constructor.html#a9fe7a0a5c6583be4dbf9e7ebf4ca7f5e">invoke</a>(<span class="stringliteral">"Hello World"</span>); <span class="comment">// returns an ptr to the object on the heap</span></div><div class="line"></div><div class="line"><a class="code" href="classrttr_1_1type.html#a5336e448f0881d2141be932e74fc756f">type::get</a>(<span class="stringliteral">"std::string"</span>).<a class="code" href="classrttr_1_1type.html#a12d900648f71d11873896f58b1f9a3ac">get_destructor</a>().<a class="code" href="classrttr_1_1destructor.html#a93d528bf4496174e7ab046dc714b2846">invoke</a>(my_string);</div><div class="line"></div><div class="line">my_string.is_valid(); <span class="comment">// yield to false</span></div></div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a class="el" href="classrttr_1_1method.html" title="The method class provides several meta information about a method and can be invoked.">method</a>, <a class="el" href="classrttr_1_1property.html" title="The property class provides several meta information about a property and gives read/write access to ...">property</a>, <a class="el" href="classrttr_1_1enumeration.html" title="The enumeration class provides several meta information about an enum.">enumeration</a>, <a class="el" href="classrttr_1_1constructor.html" title="The constructor class provides several meta information about a constructor and can be invoked.">constructor</a> and <a class="el" href="classrttr_1_1type.html" title="The type class holds the type information for any arbitrary object.">type</a> </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a0b8c6489f17d40c7a221d833d8b8b85e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b8c6489f17d40c7a221d833d8b8b85e">◆ </a></span>get_declaring_type()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classrttr_1_1type.html">type</a> rttr::destructor::get_declaring_type </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the class that declares this destructor. </p>
<dl class="section remark"><dt>Remarks</dt><dd>When this destructor is not valid, this function will return an invalid type object (see <a class="el" href="classrttr_1_1type.html#a5d6b241be3e6a25d787248e0b9d6f20b">type::is_valid</a>).</dd></dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classrttr_1_1type.html">Type</a> of the declaring class/struct for this destructor. </dd></dl>
</div>
</div>
<a id="a5f6257216d80cac7eea9fc9b33df44d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f6257216d80cac7eea9fc9b33df44d1">◆ </a></span>get_destructed_type()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classrttr_1_1type.html">type</a> rttr::destructor::get_destructed_type </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the <a class="el" href="classrttr_1_1type.html" title="The type class holds the type information for any arbitrary object.">rttr::type</a> for which this destructor can delete objects. </p>
<dl class="section return"><dt>Returns</dt><dd>The type of this destructor. </dd></dl>
</div>
</div>
<a id="a93d528bf4496174e7ab046dc714b2846"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93d528bf4496174e7ab046dc714b2846">◆ </a></span>invoke()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool rttr::destructor::invoke </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classrttr_1_1variant.html">variant</a> & </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys the contained object in the variant <code>obj</code>. </p>
<dl class="section remark"><dt>Remarks</dt><dd>When the <code>obj</code> could be destroyed the given <code>obj</code> is invalid after calling this method; Otherwise it is still valid.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>True if the destructor of the object could be invoked, otherwise false. </dd></dl>
</div>
</div>
<a id="ad90bf497e9201c974341cc8756a19112"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad90bf497e9201c974341cc8756a19112">◆ </a></span>is_valid()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool rttr::destructor::is_valid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true whether this destructor object is valid; otherwise false. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns true when the destructor is valid; otherwise false. </dd></dl>
</div>
</div>
<a id="a55910565530b9f3a6e16e994ffa82ddc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55910565530b9f3a6e16e994ffa82ddc">◆ </a></span>operator bool()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">rttr::destructor::operator bool </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience function to check if this destructor is valid or not. </p>
<dl class="section return"><dt>Returns</dt><dd>True if this destructor is valid, otherwise false. </dd></dl>
</div>
</div>
<a id="aca5703f168a59592322d326a98d62547"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca5703f168a59592322d326a98d62547">◆ </a></span>operator!=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool rttr::destructor::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classrttr_1_1destructor.html">destructor</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if this destructor is the not the same like the <code>other</code>. </p>
<dl class="section return"><dt>Returns</dt><dd>True if both destructors are different, otherwise false. </dd></dl>
</div>
</div>
<a id="ab6018f6fd87d3a4075d5f3703ab87948"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6018f6fd87d3a4075d5f3703ab87948">◆ </a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool rttr::destructor::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classrttr_1_1destructor.html">destructor</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if this destructor is the same like the <code>other</code>. </p>
<dl class="section return"><dt>Returns</dt><dd>True if both destructors are equal, otherwise false. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="destructor_8h_source.html">destructor.h</a></li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.9.1-->
<!-- start footer part -->
<hr class="footer"/>
<address class="footer">
<small>
Generated on Thu Apr 11 2019 20:05:58 for rttr - 0.9.6 by
<a href="http://www.doxygen.org/index.html">doxygen</a>.
</small>
</address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
d8d30ad953f2dbe7e871721325480315
>
files
>
187
