<!-- 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::policy::ctor Struct 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="structrttr_1_1policy.html">policy</a></li><li class="navelem"><a class="el" href="structrttr_1_1policy_1_1ctor.html">ctor</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="structrttr_1_1policy_1_1ctor-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">rttr::policy::ctor Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="structrttr_1_1policy_1_1ctor.html">ctor</a> class groups all policies that can be used during registration of constructors.
<a href="structrttr_1_1policy_1_1ctor.html#details">More...</a></p>
<p><code>#include <<a class="el" href="policy_8h_source.html">policy.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a1e3b8ee81a41ce6b2e075bef1620f28c"><td class="memItemLeft" align="right" valign="top">static const detail::as_object </td><td class="memItemRight" valign="bottom"><a class="el" href="structrttr_1_1policy_1_1ctor.html#a1e3b8ee81a41ce6b2e075bef1620f28c">as_object</a></td></tr>
<tr class="memdesc:a1e3b8ee81a41ce6b2e075bef1620f28c"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="structrttr_1_1policy_1_1ctor.html#a1e3b8ee81a41ce6b2e075bef1620f28c">as_object</a> policy will create an instance of a class with automatic storage. <a href="#a1e3b8ee81a41ce6b2e075bef1620f28c">More...</a><br /></td></tr>
<tr class="separator:a1e3b8ee81a41ce6b2e075bef1620f28c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a8150de98f16fdad329b85f43d32da1"><td class="memItemLeft" align="right" valign="top">static const detail::as_raw_pointer </td><td class="memItemRight" valign="bottom"><a class="el" href="structrttr_1_1policy_1_1ctor.html#a3a8150de98f16fdad329b85f43d32da1">as_raw_ptr</a></td></tr>
<tr class="memdesc:a3a8150de98f16fdad329b85f43d32da1"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="structrttr_1_1policy_1_1ctor.html#a3a8150de98f16fdad329b85f43d32da1">as_raw_ptr</a> policy will create an instance of a class as raw pointer. <a href="#a3a8150de98f16fdad329b85f43d32da1">More...</a><br /></td></tr>
<tr class="separator:a3a8150de98f16fdad329b85f43d32da1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a40f2a2ef8f270cad3deabf1b83e8764c"><td class="memItemLeft" align="right" valign="top">static const detail::as_std_shared_ptr </td><td class="memItemRight" valign="bottom"><a class="el" href="structrttr_1_1policy_1_1ctor.html#a40f2a2ef8f270cad3deabf1b83e8764c">as_std_shared_ptr</a></td></tr>
<tr class="memdesc:a40f2a2ef8f270cad3deabf1b83e8764c"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="structrttr_1_1policy_1_1ctor.html#a40f2a2ef8f270cad3deabf1b83e8764c">as_std_shared_ptr</a> policy will create an instance of a class through <em>std::make_shared<T></em>. <a href="#a40f2a2ef8f270cad3deabf1b83e8764c">More...</a><br /></td></tr>
<tr class="separator:a40f2a2ef8f270cad3deabf1b83e8764c"><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="structrttr_1_1policy_1_1ctor.html">ctor</a> class groups all policies that can be used during registration of constructors. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a1e3b8ee81a41ce6b2e075bef1620f28c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e3b8ee81a41ce6b2e075bef1620f28c">◆ </a></span>as_object</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const detail::as_object rttr::policy::ctor::as_object</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The <a class="el" href="structrttr_1_1policy_1_1ctor.html#a1e3b8ee81a41ce6b2e075bef1620f28c">as_object</a> policy will create an instance of a class with automatic storage. </p>
<p>Objects with automatic storage duration are automatically destroyed when the block in which they are created exits. Which is in our case the <a class="el" href="classrttr_1_1variant.html">variant</a>. However, that means also you don't have to deal with pointers or wrappers. In order to use this creation policy, the object must be <em>copy constructible</em>.</p>
<p>See following example code: </p><div class="fragment"><div class="line"><span class="keyword">using namespace </span><a class="code" href="namespacerttr.html">rttr</a>;</div><div class="line"><span class="keyword">struct </span>Foo</div><div class="line">{</div><div class="line">};</div><div class="line"></div><div class="line"><a class="code" href="registration_8h.html#ac6326400f16225ee15b52eabcaae8130">RTTR_REGISTRATION</a></div><div class="line">{</div><div class="line"> <a class="code" href="classrttr_1_1registration_1_1class__.html">registration::class_<Foo></a>(<span class="stringliteral">"Foo"</span>)</div><div class="line"> .<a class="code" href="classrttr_1_1registration_1_1class__.html#a92925cd9adc8c53c6c2df6e5f7f86e8a">constructor</a><>()</div><div class="line"> (</div><div class="line"> <a class="code" href="structrttr_1_1policy_1_1ctor.html#a1e3b8ee81a41ce6b2e075bef1620f28c">policy::ctor::as_object</a></div><div class="line"> );</div><div class="line">}</div><div class="line"></div><div class="line"><span class="keywordtype">int</span> main()</div><div class="line">{</div><div class="line"> <a class="code" href="classrttr_1_1variant.html">variant</a> var = type::get<Foo>().create(); <span class="comment">// creates a new instance of 'Foo' and moves the content into variant 'var'</span></div><div class="line"> std::cout << var.<a class="code" href="classrttr_1_1variant.html#a8a2fe635a8452ac3a2370589d6fc4bfb">is_type</a><Foo>(); <span class="comment">// prints "true"</span></div><div class="line"> <a class="code" href="classrttr_1_1variant.html">variant</a> var2 = var; <span class="comment">// creates a new instance of 'Foo', through copy construction</span></div><div class="line"> <span class="keywordflow">return</span> 0; <span class="comment">// the memory of the two 'Foo' instances is freed automatically</span></div><div class="line">}</div></div><!-- fragment -->
</div>
</div>
<a id="a3a8150de98f16fdad329b85f43d32da1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a8150de98f16fdad329b85f43d32da1">◆ </a></span>as_raw_ptr</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const detail::as_raw_pointer rttr::policy::ctor::as_raw_ptr</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The <a class="el" href="structrttr_1_1policy_1_1ctor.html#a3a8150de98f16fdad329b85f43d32da1">as_raw_ptr</a> policy will create an instance of a class as raw pointer. </p>
<p>That means the object is created with a <em>new</em>-expression and its lifetime lasts until it is destroyed using a <em>delete</em>-expression. In order to invoke the delete expression use the corresponding <a class="el" href="classrttr_1_1destructor.html">destructor</a>.</p>
<p>See following example code: </p><div class="fragment"><div class="line"><span class="keyword">using namespace </span><a class="code" href="namespacerttr.html">rttr</a>;</div><div class="line"><span class="keyword">struct </span>Foo</div><div class="line">{</div><div class="line">};</div><div class="line"></div><div class="line"><a class="code" href="registration_8h.html#ac6326400f16225ee15b52eabcaae8130">RTTR_REGISTRATION</a></div><div class="line">{</div><div class="line"> <a class="code" href="classrttr_1_1registration_1_1class__.html">registration::class_<Foo></a>(<span class="stringliteral">"Foo"</span>)</div><div class="line"> .<a class="code" href="classrttr_1_1registration_1_1class__.html#a92925cd9adc8c53c6c2df6e5f7f86e8a">constructor</a><>()</div><div class="line"> (</div><div class="line"> <a class="code" href="structrttr_1_1policy_1_1ctor.html#a3a8150de98f16fdad329b85f43d32da1">policy::ctor::as_raw_ptr</a></div><div class="line"> );</div><div class="line">}</div><div class="line"></div><div class="line"><span class="keywordtype">int</span> main()</div><div class="line">{</div><div class="line"> <a class="code" href="classrttr_1_1variant.html">variant</a> var = type::get<Foo>().create();</div><div class="line"> std::cout << var.<a class="code" href="classrttr_1_1variant.html#a8a2fe635a8452ac3a2370589d6fc4bfb">is_type</a><Foo*>(); <span class="comment">// prints "true"</span></div><div class="line"> var.<a class="code" href="classrttr_1_1variant.html#a7a72579286ed164225c5be882ab6ea81">get_type</a>().<a class="code" href="classrttr_1_1type.html#a33bc44604dae75f4368428afabf364ac">destroy</a>(var); <span class="comment">// free's the memory with 'delete'</span></div><div class="line"> std::cout << var.<a class="code" href="classrttr_1_1variant.html#aed6e6a2e29b4d1ac51a09b7d9037dd44">is_valid</a>(); <span class="comment">// prints "false"</span></div><div class="line"> <span class="keywordflow">return</span> 0;</div><div class="line">}</div></div><!-- fragment -->
</div>
</div>
<a id="a40f2a2ef8f270cad3deabf1b83e8764c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40f2a2ef8f270cad3deabf1b83e8764c">◆ </a></span>as_std_shared_ptr</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const detail::as_std_shared_ptr rttr::policy::ctor::as_std_shared_ptr</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The <a class="el" href="structrttr_1_1policy_1_1ctor.html#a40f2a2ef8f270cad3deabf1b83e8764c">as_std_shared_ptr</a> policy will create an instance of a class through <em>std::make_shared<T></em>. </p>
<p>That means the object is <a class="el" href="classrttr_1_1type.html#af1bd09e2408fbc2816e201c2d82df582">wrapped</a> into a <em>std::shared_ptr<T></em>. The wrapped object is destroyed and its memory deallocated when either of the following happens:</p><ul>
<li>the last remaining variant owning the <em>shared_ptr</em> is destroyed</li>
<li>the last remaining variant owning the <em>shared_ptr</em> is assigned another data or variant</li>
</ul>
<p>The object is destroyed using the default deleter of <em>std::shared_ptr</em>.</p>
<p>See following example code: </p><div class="fragment"><div class="line"><span class="keyword">using namespace </span><a class="code" href="namespacerttr.html">rttr</a>;</div><div class="line"><span class="keyword">struct </span>Foo</div><div class="line">{</div><div class="line">};</div><div class="line"></div><div class="line"><a class="code" href="registration_8h.html#ac6326400f16225ee15b52eabcaae8130">RTTR_REGISTRATION</a></div><div class="line">{</div><div class="line"> <a class="code" href="classrttr_1_1registration_1_1class__.html">registration::class_<Foo></a>(<span class="stringliteral">"Foo"</span>)</div><div class="line"> .<a class="code" href="classrttr_1_1registration_1_1class__.html#a92925cd9adc8c53c6c2df6e5f7f86e8a">constructor</a><>()</div><div class="line"> (</div><div class="line"> <a class="code" href="structrttr_1_1policy_1_1ctor.html#a40f2a2ef8f270cad3deabf1b83e8764c">policy::ctor::as_std_shared_ptr</a></div><div class="line"> );</div><div class="line">}</div><div class="line"></div><div class="line"><span class="keywordtype">int</span> main()</div><div class="line">{</div><div class="line"> <a class="code" href="classrttr_1_1variant.html">variant</a> var = type::get<Foo>().create();</div><div class="line"> std::cout << var.<a class="code" href="classrttr_1_1variant.html#a8a2fe635a8452ac3a2370589d6fc4bfb">is_type</a><std::shared_ptr<Foo>>(); <span class="comment">// prints "true"</span></div><div class="line"> <span class="keywordflow">return</span> 0; <span class="comment">// the memory for contained 'Foo' instance is freed automatically,</span></div><div class="line">} <span class="comment">// because the var object is gone out of scope</span></div></div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="policy_8h_source.html">policy.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:59 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
>
385
