<!-- 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::meth 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_1meth.html">meth</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_1meth-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">rttr::policy::meth Struct Reference</div> </div> </div><!--header--> <div class="contents"> <p>The <a class="el" href="structrttr_1_1policy_1_1meth.html">meth</a> class groups all policies that can be used during registration of methods. <a href="structrttr_1_1policy_1_1meth.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:a1797eaaddcd48aa0de8edd79ea9070f9"><td class="memItemLeft" align="right" valign="top">static const detail::discard_return </td><td class="memItemRight" valign="bottom"><a class="el" href="structrttr_1_1policy_1_1meth.html#a1797eaaddcd48aa0de8edd79ea9070f9">discard_return</a></td></tr> <tr class="memdesc:a1797eaaddcd48aa0de8edd79ea9070f9"><td class="mdescLeft"> </td><td class="mdescRight">This policy should be used when the return value of a method should not be forwarded to the caller. <a href="#a1797eaaddcd48aa0de8edd79ea9070f9">More...</a><br /></td></tr> <tr class="separator:a1797eaaddcd48aa0de8edd79ea9070f9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad67ab6cccd0eefa54b80a83851105018"><td class="memItemLeft" align="right" valign="top">static const detail::return_as_ptr </td><td class="memItemRight" valign="bottom"><a class="el" href="structrttr_1_1policy_1_1meth.html#ad67ab6cccd0eefa54b80a83851105018">return_ref_as_ptr</a></td></tr> <tr class="memdesc:ad67ab6cccd0eefa54b80a83851105018"><td class="mdescLeft"> </td><td class="mdescRight">This policy can be used when a method return a reference to an object and the caller should be able to access this object via the returned variant. <a href="#ad67ab6cccd0eefa54b80a83851105018">More...</a><br /></td></tr> <tr class="separator:ad67ab6cccd0eefa54b80a83851105018"><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_1meth.html">meth</a> class groups all policies that can be used during registration of methods. </p> </div><h2 class="groupheader">Member Data Documentation</h2> <a id="a1797eaaddcd48aa0de8edd79ea9070f9"></a> <h2 class="memtitle"><span class="permalink"><a href="#a1797eaaddcd48aa0de8edd79ea9070f9">◆ </a></span>discard_return</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const detail::discard_return rttr::policy::meth::discard_return</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>This policy should be used when the return value of a method should not be forwarded to the caller. </p> <p>For the caller it looks like the method has no return value, the return type will be <em>void</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="keywordtype">int</span> my_func() { <span class="keywordflow">return</span> 42; }</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.html#a5da1c6eb947d700681faa7fec0bf23b7">registration::method</a>(<span class="stringliteral">"my_func"</span>, &my_func)</div><div class="line"> (</div><div class="line"> <a class="code" href="structrttr_1_1policy_1_1meth.html#a1797eaaddcd48aa0de8edd79ea9070f9">policy::meth::discard_return</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_1method.html">method</a> meth = <a class="code" href="classrttr_1_1type.html#a15fa4ae4fb0619be68c3b83967fefb51">type::get_global_method</a>(<span class="stringliteral">"my_func"</span>);</div><div class="line"> std::cout << meth.<a class="code" href="classrttr_1_1method.html#a6664f371e32d239c5dfdc7abdcf9ba53">get_return_type</a>().<a class="code" href="classrttr_1_1type.html#a16d519457c68429ef2316067d1cf6700">get_name</a>(); <span class="comment">// prints "void"</span></div><div class="line"> <a class="code" href="classrttr_1_1variant.html">variant</a> var = meth.<a class="code" href="classrttr_1_1method.html#aea4351075b4cbe6f2f2b6500cf226f20">invoke</a>(<a class="code" href="classrttr_1_1instance.html">instance</a>());</div><div class="line"> std::cout << var.<a class="code" href="classrttr_1_1variant.html#a8a2fe635a8452ac3a2370589d6fc4bfb">is_type</a><<span class="keywordtype">void</span>>(); <span class="comment">// prints "true"</span></div><div class="line"> <span class="keywordflow">return</span> 0;</div><div class="line">}</div></div><!-- fragment --> </div> </div> <a id="ad67ab6cccd0eefa54b80a83851105018"></a> <h2 class="memtitle"><span class="permalink"><a href="#ad67ab6cccd0eefa54b80a83851105018">◆ </a></span>return_ref_as_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::return_as_ptr rttr::policy::meth::return_ref_as_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>This policy can be used when a method return a reference to an object and the caller should be able to access this object via the returned variant. </p> <p>Reference cannot be copied directly in a variant, therefore it is possible transform the reference to a pointer.</p> <p>See following example code: </p><div class="fragment"><div class="line">std::string& get_text() { <span class="keyword">static</span> std:<span class="keywordtype">string</span> text(<span class="stringliteral">"hello world"</span>); <span class="keywordflow">return</span> text; }</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.html#a5da1c6eb947d700681faa7fec0bf23b7">registration::method</a>(<span class="stringliteral">"get_text"</span>, &get_text)</div><div class="line"> (</div><div class="line"> <a class="code" href="structrttr_1_1policy_1_1meth.html#ad67ab6cccd0eefa54b80a83851105018">policy::meth::return_ref_as_ptr</a></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"> method meth = <a class="code" href="classrttr_1_1type.html#a15fa4ae4fb0619be68c3b83967fefb51">type::get_global_method</a>(<span class="stringliteral">"get_text"</span>);</div><div class="line"> std::cout << meth.get_return_type().get_name(); <span class="comment">// prints "std::string*"</span></div><div class="line"> variant var = meth.invoke(instance());</div><div class="line"> std::cout << var.<a class="code" href="classrttr_1_1variant.html#a8a2fe635a8452ac3a2370589d6fc4bfb">is_type</a><std::string*>(); <span class="comment">// prints "true"</span></div><div class="line"> <span class="keywordflow">return</span> 0;</div><div class="line">}</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>