<!-- 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::property 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_1property.html">property</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classrttr_1_1property-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">rttr::property Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="classrttr_1_1property.html">property</a> class provides several meta information about a property and gives read/write access to its value.
<a href="classrttr_1_1property.html#details">More...</a></p>
<p><code>#include <<a class="el" href="property_8h_source.html">property.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:ae3d36f39f60d0aca13d4c6b039799c7d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacerttr.html#aa07db0e4984d0c48adc5d61f834d611b">access_levels</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1property.html#ae3d36f39f60d0aca13d4c6b039799c7d">get_access_level</a> () const noexcept</td></tr>
<tr class="memdesc:ae3d36f39f60d0aca13d4c6b039799c7d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the access level with which this property was <a class="el" href="classrttr_1_1registration_1_1class__.html#a005a60417fb6d183af475cb4059dc0a0">registered</a>. <a href="#ae3d36f39f60d0aca13d4c6b039799c7d">More...</a><br /></td></tr>
<tr class="separator:ae3d36f39f60d0aca13d4c6b039799c7d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd7ba136741c4c81d53a0c1cb2c4684c"><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_1property.html#afd7ba136741c4c81d53a0c1cb2c4684c">get_declaring_type</a> () const noexcept</td></tr>
<tr class="memdesc:afd7ba136741c4c81d53a0c1cb2c4684c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="classrttr_1_1type.html">type</a> of the class or struct that declares this property. <a href="#afd7ba136741c4c81d53a0c1cb2c4684c">More...</a><br /></td></tr>
<tr class="separator:afd7ba136741c4c81d53a0c1cb2c4684c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8505269e5b2d12c69ffec3c2bdca4e51"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classrttr_1_1enumeration.html">enumeration</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1property.html#a8505269e5b2d12c69ffec3c2bdca4e51">get_enumeration</a> () const noexcept</td></tr>
<tr class="memdesc:a8505269e5b2d12c69ffec3c2bdca4e51"><td class="mdescLeft"> </td><td class="mdescRight">Returns the enumerator if this property is an enum type; otherwise the returned value is <a class="el" href="classrttr_1_1enumeration.html#a465644dd0af25f6d55cd17704c4e6137">not valid</a>. <a href="#a8505269e5b2d12c69ffec3c2bdca4e51">More...</a><br /></td></tr>
<tr class="separator:a8505269e5b2d12c69ffec3c2bdca4e51"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae1b6d30a595ebfe44ae569f6b45b8cac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classrttr_1_1variant.html">variant</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1property.html#ae1b6d30a595ebfe44ae569f6b45b8cac">get_metadata</a> (const <a class="el" href="classrttr_1_1variant.html">variant</a> &key) const</td></tr>
<tr class="memdesc:ae1b6d30a595ebfe44ae569f6b45b8cac"><td class="mdescLeft"> </td><td class="mdescRight">Returns the meta data for the given key <code>key</code>. <a href="#ae1b6d30a595ebfe44ae569f6b45b8cac">More...</a><br /></td></tr>
<tr class="separator:ae1b6d30a595ebfe44ae569f6b45b8cac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad594e4c185f3177c8e15af86051246c5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacerttr.html#a61265f69675ac438ecfa23b084adaa56">string_view</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1property.html#ad594e4c185f3177c8e15af86051246c5">get_name</a> () const noexcept</td></tr>
<tr class="memdesc:ad594e4c185f3177c8e15af86051246c5"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of this property. <a href="#ad594e4c185f3177c8e15af86051246c5">More...</a><br /></td></tr>
<tr class="separator:ad594e4c185f3177c8e15af86051246c5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f577dd17e68af6e1177a3ce718b7a1d"><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_1property.html#a8f577dd17e68af6e1177a3ce718b7a1d">get_type</a> () const noexcept</td></tr>
<tr class="memdesc:a8f577dd17e68af6e1177a3ce718b7a1d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the underlying <a class="el" href="classrttr_1_1type.html">type</a> object of this property. <a href="#a8f577dd17e68af6e1177a3ce718b7a1d">More...</a><br /></td></tr>
<tr class="separator:a8f577dd17e68af6e1177a3ce718b7a1d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a324d3c3065ebe9db99c3962a9fe0a41b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classrttr_1_1variant.html">variant</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1property.html#a324d3c3065ebe9db99c3962a9fe0a41b">get_value</a> (<a class="el" href="classrttr_1_1instance.html">instance</a> object) const</td></tr>
<tr class="memdesc:a324d3c3065ebe9db99c3962a9fe0a41b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current property value of the given instance <code>object</code>. <a href="#a324d3c3065ebe9db99c3962a9fe0a41b">More...</a><br /></td></tr>
<tr class="separator:a324d3c3065ebe9db99c3962a9fe0a41b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9fcf288394e598a7919671eefe9e9007"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1property.html#a9fcf288394e598a7919671eefe9e9007">is_enumeration</a> () const noexcept</td></tr>
<tr class="memdesc:a9fcf288394e598a7919671eefe9e9007"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the underlying property is an <a class="el" href="classrttr_1_1enumeration.html">enumeration</a>. <a href="#a9fcf288394e598a7919671eefe9e9007">More...</a><br /></td></tr>
<tr class="separator:a9fcf288394e598a7919671eefe9e9007"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a40eb3f00d86749bcec302e92baba62fa"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1property.html#a40eb3f00d86749bcec302e92baba62fa">is_readonly</a> () const noexcept</td></tr>
<tr class="memdesc:a40eb3f00d86749bcec302e92baba62fa"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this property is read only, otherwise false. <a href="#a40eb3f00d86749bcec302e92baba62fa">More...</a><br /></td></tr>
<tr class="separator:a40eb3f00d86749bcec302e92baba62fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a63fa18e825e33f1d3bd1d406360d497e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1property.html#a63fa18e825e33f1d3bd1d406360d497e">is_static</a> () const noexcept</td></tr>
<tr class="memdesc:a63fa18e825e33f1d3bd1d406360d497e"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this property is static property, otherwise false. <a href="#a63fa18e825e33f1d3bd1d406360d497e">More...</a><br /></td></tr>
<tr class="separator:a63fa18e825e33f1d3bd1d406360d497e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7d37e1dec52f868163de2adf8bad097f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1property.html#a7d37e1dec52f868163de2adf8bad097f">is_valid</a> () const noexcept</td></tr>
<tr class="memdesc:a7d37e1dec52f868163de2adf8bad097f"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this property is valid, otherwise false. <a href="#a7d37e1dec52f868163de2adf8bad097f">More...</a><br /></td></tr>
<tr class="separator:a7d37e1dec52f868163de2adf8bad097f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a41d4027c43936585c2414718c3fa9a3f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1property.html#a41d4027c43936585c2414718c3fa9a3f">operator bool</a> () const noexcept</td></tr>
<tr class="memdesc:a41d4027c43936585c2414718c3fa9a3f"><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to check if this property is valid or not. <a href="#a41d4027c43936585c2414718c3fa9a3f">More...</a><br /></td></tr>
<tr class="separator:a41d4027c43936585c2414718c3fa9a3f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a33e8a904703391b44d8dad6962b124df"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1property.html#a33e8a904703391b44d8dad6962b124df">operator!=</a> (const <a class="el" href="classrttr_1_1property.html">property</a> &other) const noexcept</td></tr>
<tr class="memdesc:a33e8a904703391b44d8dad6962b124df"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this property is the not the same like the <code>other</code>. <a href="#a33e8a904703391b44d8dad6962b124df">More...</a><br /></td></tr>
<tr class="separator:a33e8a904703391b44d8dad6962b124df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aac4e05734b0f6777433d22f95514afbe"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1property.html#aac4e05734b0f6777433d22f95514afbe">operator==</a> (const <a class="el" href="classrttr_1_1property.html">property</a> &other) const noexcept</td></tr>
<tr class="memdesc:aac4e05734b0f6777433d22f95514afbe"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this property is the same like the <code>other</code>. <a href="#aac4e05734b0f6777433d22f95514afbe">More...</a><br /></td></tr>
<tr class="separator:aac4e05734b0f6777433d22f95514afbe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1bb74b1d1910edf6cabec250df8da021"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1property.html#a1bb74b1d1910edf6cabec250df8da021">set_value</a> (<a class="el" href="classrttr_1_1instance.html">instance</a> object, <a class="el" href="classrttr_1_1argument.html">argument</a> arg) const</td></tr>
<tr class="memdesc:a1bb74b1d1910edf6cabec250df8da021"><td class="mdescLeft"> </td><td class="mdescRight">Set the property of the given instance <code>object</code> to the given value <code>arg</code>. <a href="#a1bb74b1d1910edf6cabec250df8da021">More...</a><br /></td></tr>
<tr class="separator:a1bb74b1d1910edf6cabec250df8da021"><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_1property.html">property</a> class provides several meta information about a property and gives read/write access to its value. </p>
<p>A instance of a property 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#ae53c4df812c270f3f74b77210bc6a926">type::get_property()</a> and <a class="el" href="classrttr_1_1type.html#af4d2837c650a639b9aab9bd6e580dc8a">type::get_properties()</a>.</p>
<p>For registration a property, nested inside a class, see <a class="el" href="classrttr_1_1registration_1_1class__.html#a005a60417fb6d183af475cb4059dc0a0">registration::class_<T>::property()</a> and for global properties see <a class="el" href="classrttr_1_1registration.html#a3331d6ccc45422da21e36937edcce4e0">registration::property()</a>.</p>
<h2>Meta Information </h2>
<p>A <a class="el" href="classrttr_1_1property.html">property</a> has a <a class="el" href="classrttr_1_1property.html#ad594e4c185f3177c8e15af86051246c5">name</a>, and a <a class="el" href="classrttr_1_1property.html#a8f577dd17e68af6e1177a3ce718b7a1d">type</a> as well as attributes that specify its behavior: <a class="el" href="classrttr_1_1property.html#a40eb3f00d86749bcec302e92baba62fa">is_readonly()</a>, <a class="el" href="classrttr_1_1property.html#a63fa18e825e33f1d3bd1d406360d497e">is_static()</a>, <a class="el" href="classrttr_1_1property.html#a9fcf288394e598a7919671eefe9e9007">is_enumeration()</a>, is_array(). When the <a class="el" href="classrttr_1_1property.html">property</a> was declared inside a class, then <a class="el" href="classrttr_1_1property.html#afd7ba136741c4c81d53a0c1cb2c4684c">get_declaring_type()</a> can be used to obtain the type of this class.</p>
<p>The property's values are set and retrieved with <a class="el" href="classrttr_1_1property.html#a1bb74b1d1910edf6cabec250df8da021">set_value()</a> and <a class="el" href="classrttr_1_1property.html#a324d3c3065ebe9db99c3962a9fe0a41b">get_value()</a>; When its not a <a class="el" href="classrttr_1_1property.html#a63fa18e825e33f1d3bd1d406360d497e">static property</a> you have to provide a class instance to set/get the property value. This instance can be the raw type on the stack; the current hierarchy level doesn't matter. It can be also a raw pointer to the object or a <a class="el" href="classrttr_1_1variant.html">variant</a> which contains the instance, again as pointer or stack object. When the property is declared as <a class="el" href="classrttr_1_1property.html#a63fa18e825e33f1d3bd1d406360d497e">static</a> you you still have to provide an empty instance object, use therefore the default ctor of <a class="el" href="classrttr_1_1instance.html#a0cf19f806ca5d41cf2341a08c0c3a38c">instance()</a>, or as shortcut use simply <code>{}</code>.</p>
<p>A property will be successfully <a class="el" href="classrttr_1_1property.html#a1bb74b1d1910edf6cabec250df8da021">set</a> when the provided instance can be converted to the <a class="el" href="classrttr_1_1property.html#afd7ba136741c4c81d53a0c1cb2c4684c">declared class</a> type. The new forwarded property value must 100% match the type of the registered property. An automatically type conversion is <b>not</b> performed.</p>
<p>The return type of <a class="el" href="classrttr_1_1property.html#a324d3c3065ebe9db99c3962a9fe0a41b">get_value()</a> is <a class="el" href="classrttr_1_1variant.html">variant</a> object. This object contains not only the value of the property, it also indicates whether the property value could be retrieved or not. A <a class="el" href="classrttr_1_1variant.html#aed6e6a2e29b4d1ac51a09b7d9037dd44">valid</a> variant object means, that the property was successfully retrieved, otherwise not.</p>
<p>Another way to get access a property is through <a class="el" href="classrttr_1_1type.html">type's</a> set and get functions. See <a class="el" href="classrttr_1_1type.html#af57f575909bf13fa24d03ad14393204a">type::set_property_value()</a> and <a class="el" href="classrttr_1_1type.html#a3010aa9577570ea86078b2ce2b2f8677" title="Returns the property value of property named name from the instance obj.">type::get_property_value()</a> for details.</p>
<h2>Copying and Assignment </h2>
<p>A <a class="el" href="classrttr_1_1property.html">property</a> object is lightweight and can be copied by value. However, each copy will refer to the same underlying property.</p>
<h2>Typical Usage </h2>
<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>MyStruct { <span class="keywordtype">int</span> <a class="code" href="namespacerttr.html#a54ecd8bad715cbc451e7aa8491667d4a">value</a> = 23; };</div><div class="line"><span class="comment">//...</span></div><div class="line"><a class="code" href="classrttr_1_1variant.html">variant</a> obj = <a class="code" href="classrttr_1_1type.html#a7ba79b9f4916c30db74fe65508dca033">type::get_by_name</a>(<span class="stringliteral">"MyStruct"</span>).<a class="code" href="classrttr_1_1type.html#ad44572a03514d83035580f516ebaf4e1">create</a>({});</div><div class="line"><span class="keyword">property</span> prop = <a class="code" href="classrttr_1_1type.html#a7ba79b9f4916c30db74fe65508dca033">type::get_by_name</a>(<span class="stringliteral">"MyStruct"</span>).<a class="code" href="classrttr_1_1type.html#ae53c4df812c270f3f74b77210bc6a926">get_property</a>(<span class="stringliteral">"value"</span>);</div><div class="line"><span class="keywordflow">if</span> (prop)</div><div class="line">{</div><div class="line"> <a class="code" href="classrttr_1_1variant.html">variant</a> val = prop.<a class="code" href="classrttr_1_1variant.html#aa3a9f7e07cdc4d922a4e09882c5c0574">get_value</a>(obj);</div><div class="line"> std::cout << val.<a class="code" href="classrttr_1_1variant.html#aa3a9f7e07cdc4d922a4e09882c5c0574">get_value</a><<span class="keywordtype">int</span>>(); <span class="comment">// prints 23</span></div><div class="line"> MyStruct inst;</div><div class="line"> val = prop.set_value(inst, 42);</div><div class="line"> std::cout << inst.value; <span class="comment">// prints 42</span></div><div class="line"> <span class="comment">// or as pointer</span></div><div class="line"> MyStruct* ptr = &inst;</div><div class="line"> val = prop.set_value(ptr, 7);</div><div class="line"> std::cout << ptr->value; <span class="comment">// prints 7</span></div><div class="line"> <span class="comment">// or do it all in one call</span></div><div class="line"> <a class="code" href="classrttr_1_1type.html#a5336e448f0881d2141be932e74fc756f">type::get</a>(inst).set_propert_value(<span class="stringliteral">"value"</span>, inst, 1024);</div><div class="line"> std::cout << inst.value; <span class="comment">// prints 1024</span></div><div class="line">}</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_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="ae3d36f39f60d0aca13d4c6b039799c7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3d36f39f60d0aca13d4c6b039799c7d">◆ </a></span>get_access_level()</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="namespacerttr.html#aa07db0e4984d0c48adc5d61f834d611b">access_levels</a> rttr::property::get_access_level </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 access level with which this property was <a class="el" href="classrttr_1_1registration_1_1class__.html#a005a60417fb6d183af475cb4059dc0a0">registered</a>. </p>
<dl class="section remark"><dt>Remarks</dt><dd>When the property is not valid, this function will return level <a class="el" href="namespacerttr.html#aa07db0e4984d0c48adc5d61f834d611ba84807fec67699af41c7bcb3a57dce40b">access_levels::public_access</a>.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="namespacerttr.html#aa07db0e4984d0c48adc5d61f834d611b">access_levels</a> of the property. </dd></dl>
</div>
</div>
<a id="afd7ba136741c4c81d53a0c1cb2c4684c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd7ba136741c4c81d53a0c1cb2c4684c">◆ </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::property::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 <a class="el" href="classrttr_1_1type.html">type</a> of the class or struct that declares this property. </p>
<dl class="section remark"><dt>Remarks</dt><dd>When this property does not belong to a class (i.e. is a global property) it will return an invalid type object. When this property 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 property. </dd></dl>
</div>
</div>
<a id="a8505269e5b2d12c69ffec3c2bdca4e51"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8505269e5b2d12c69ffec3c2bdca4e51">◆ </a></span>get_enumeration()</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_1enumeration.html">enumeration</a> rttr::property::get_enumeration </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 enumerator if this property is an enum type; otherwise the returned value is <a class="el" href="classrttr_1_1enumeration.html#a465644dd0af25f6d55cd17704c4e6137">not valid</a>. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classrttr_1_1property.html#a9fcf288394e598a7919671eefe9e9007" title="Returns true if the underlying property is an enumeration.">is_enumeration()</a></dd></dl>
<dl class="section return"><dt>Returns</dt><dd>An enumeration object. </dd></dl>
</div>
</div>
<a id="ae1b6d30a595ebfe44ae569f6b45b8cac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1b6d30a595ebfe44ae569f6b45b8cac">◆ </a></span>get_metadata()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classrttr_1_1variant.html">variant</a> rttr::property::get_metadata </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classrttr_1_1variant.html">variant</a> & </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the meta data for the given key <code>key</code>. </p>
<dl class="section remark"><dt>Remarks</dt><dd>When no meta data is registered with the given <code>key</code>, an invalid <a class="el" href="classrttr_1_1variant.html">variant</a> object is returned (see <a class="el" href="classrttr_1_1variant.html#aed6e6a2e29b4d1ac51a09b7d9037dd44">variant::is_valid</a>).</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>A variant object, containing arbitrary data. </dd></dl>
</div>
</div>
<a id="ad594e4c185f3177c8e15af86051246c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad594e4c185f3177c8e15af86051246c5">◆ </a></span>get_name()</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="namespacerttr.html#a61265f69675ac438ecfa23b084adaa56">string_view</a> rttr::property::get_name </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 name of this property. </p>
<dl class="section remark"><dt>Remarks</dt><dd>When the property is not valid, this function will return an empty string_view.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>Name of the property. </dd></dl>
</div>
</div>
<a id="a8f577dd17e68af6e1177a3ce718b7a1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f577dd17e68af6e1177a3ce718b7a1d">◆ </a></span>get_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::property::get_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 underlying <a class="el" href="classrttr_1_1type.html">type</a> object of this property. </p>
<dl class="section remark"><dt>Remarks</dt><dd>When the property is not valid, this function will return an invalid type object.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classrttr_1_1type.html">Type</a> of the underlying property. </dd></dl>
</div>
</div>
<a id="a324d3c3065ebe9db99c3962a9fe0a41b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a324d3c3065ebe9db99c3962a9fe0a41b">◆ </a></span>get_value()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classrttr_1_1variant.html">variant</a> rttr::property::get_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classrttr_1_1instance.html">instance</a> </td>
<td class="paramname"><em>object</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the current property value of the given instance <code>object</code>. </p>
<dl class="section remark"><dt>Remarks</dt><dd>When the property is static, you can forward an empty instance.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classrttr_1_1property.html#a1bb74b1d1910edf6cabec250df8da021" title="Set the property of the given instance object to the given value arg.">set_value()</a>.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>The property value of the given instance <code>object</code>. </dd></dl>
</div>
</div>
<a id="a9fcf288394e598a7919671eefe9e9007"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9fcf288394e598a7919671eefe9e9007">◆ </a></span>is_enumeration()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool rttr::property::is_enumeration </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 if the underlying property is an <a class="el" href="classrttr_1_1enumeration.html">enumeration</a>. </p>
<dl class="section remark"><dt>Remarks</dt><dd>When the property is not valid, this function will return false.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>True if this is a <a class="el" href="classrttr_1_1enumeration.html">enumeration</a> type, otherwise false. </dd></dl>
</div>
</div>
<a id="a40eb3f00d86749bcec302e92baba62fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40eb3f00d86749bcec302e92baba62fa">◆ </a></span>is_readonly()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool rttr::property::is_readonly </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 if this property is read only, otherwise false. </p>
<dl class="section remark"><dt>Remarks</dt><dd>When the property is not valid, this function will return false.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>True if this is a read only property, otherwise false. </dd></dl>
</div>
</div>
<a id="a63fa18e825e33f1d3bd1d406360d497e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63fa18e825e33f1d3bd1d406360d497e">◆ </a></span>is_static()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool rttr::property::is_static </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 if this property is static property, otherwise false. </p>
<p>A static property does not need an instance for performing set_value/get_value.</p>
<dl class="section remark"><dt>Remarks</dt><dd>When the property is not valid, this function will return false.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>True if this is a static property, otherwise false. </dd></dl>
</div>
</div>
<a id="a7d37e1dec52f868163de2adf8bad097f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d37e1dec52f868163de2adf8bad097f">◆ </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::property::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 if this property is valid, otherwise false. </p>
<dl class="section return"><dt>Returns</dt><dd>True if this property is valid, otherwise false. </dd></dl>
</div>
</div>
<a id="a41d4027c43936585c2414718c3fa9a3f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41d4027c43936585c2414718c3fa9a3f">◆ </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::property::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 property is valid or not. </p>
<dl class="section return"><dt>Returns</dt><dd>True if this property is valid, otherwise false. </dd></dl>
</div>
</div>
<a id="a33e8a904703391b44d8dad6962b124df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33e8a904703391b44d8dad6962b124df">◆ </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::property::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classrttr_1_1property.html">property</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 property is the not the same like the <code>other</code>. </p>
<dl class="section return"><dt>Returns</dt><dd>True if both properties are different, otherwise false. </dd></dl>
</div>
</div>
<a id="aac4e05734b0f6777433d22f95514afbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac4e05734b0f6777433d22f95514afbe">◆ </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::property::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classrttr_1_1property.html">property</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 property is the same like the <code>other</code>. </p>
<dl class="section return"><dt>Returns</dt><dd>True if both properties are equal, otherwise false. </dd></dl>
</div>
</div>
<a id="a1bb74b1d1910edf6cabec250df8da021"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1bb74b1d1910edf6cabec250df8da021">◆ </a></span>set_value()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool rttr::property::set_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classrttr_1_1instance.html">instance</a> </td>
<td class="paramname"><em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classrttr_1_1argument.html">argument</a> </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the property of the given instance <code>object</code> to the given value <code>arg</code>. </p>
<dl class="section remark"><dt>Remarks</dt><dd>When the property is declared as <a class="el" href="classrttr_1_1property.html#a40eb3f00d86749bcec302e92baba62fa">read only</a> this function will return false. When you have a static property just pass an empty instance as object argument. When the property is not valid, this function will return false.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classrttr_1_1property.html#a324d3c3065ebe9db99c3962a9fe0a41b" title="Returns the current property value of the given instance object.">get_value()</a>.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>The return value indicates whether the operation was successful or not. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="property_8h_source.html">property.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
>
201
