<!-- 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: property.h Source File</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><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">property.h</div> </div> </div><!--header--> <div class="contents"> <a href="property_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/************************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">* *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">* Copyright (c) 2014 - 2018 Axel Menzel <info@rttr.org> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">* *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">* This file is part of RTTR (Run Time Type Reflection) *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">* License: MIT License *</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">* *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">* Permission is hereby granted, free of charge, to any person obtaining *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">* a copy of this software and associated documentation files (the "Software"), *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">* to deal in the Software without restriction, including without limitation *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">* the rights to use, copy, modify, merge, publish, distribute, sublicense, *</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">* and/or sell copies of the Software, and to permit persons to whom the *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">* Software is furnished to do so, subject to the following conditions: *</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">* *</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">* The above copyright notice and this permission notice shall be included in *</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">* all copies or substantial portions of the Software. *</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">* *</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">* SOFTWARE. *</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">* *</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">*************************************************************************************/</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#ifndef RTTR_PROPERTY_H_</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#define RTTR_PROPERTY_H_</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "rttr/detail/base/core_prerequisites.h"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "rttr/detail/misc/class_item_mapper.h"</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include "<a class="code" href="parameter__info_8h.html">rttr/parameter_info.h</a>"</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include "<a class="code" href="access__levels_8h.html">rttr/access_levels.h</a>"</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include "<a class="code" href="string__view_8h.html">rttr/string_view.h</a>"</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">namespace </span><a class="code" href="namespacerttr.html">rttr</a></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">class </span>variant;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">class </span>type;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">class </span>enumeration;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">class </span>instance;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">class </span>argument;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">class </span>property;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">namespace </span>detail</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> {</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">class </span>property_wrapper_base;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> }</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="classrttr_1_1property.html"> 116</a></span> <span class="keyword">class </span>RTTR_API <a class="code" href="classrttr_1_1property.html">property</a></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> {</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keywordtype">bool</span> is_valid() <span class="keyword">const</span> RTTR_NOEXCEPT;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keyword">explicit</span> <span class="keyword">operator</span> bool() <span class="keyword">const</span> RTTR_NOEXCEPT;</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <a class="code" href="namespacerttr.html#aa07db0e4984d0c48adc5d61f834d611b">access_levels</a> get_access_level() <span class="keyword">const</span> RTTR_NOEXCEPT;</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keywordtype">bool</span> is_readonly() <span class="keyword">const</span> RTTR_NOEXCEPT;</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keywordtype">bool</span> is_static() <span class="keyword">const</span> RTTR_NOEXCEPT;</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keywordtype">bool</span> is_enumeration() <span class="keyword">const</span> RTTR_NOEXCEPT;</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> </div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <a class="code" href="classrttr_1_1enumeration.html">enumeration</a> get_enumeration() <span class="keyword">const</span> RTTR_NOEXCEPT;</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> </div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <a class="code" href="classrttr_1_1basic__string__view.html">string_view</a> get_name() <span class="keyword">const</span> RTTR_NOEXCEPT;</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <a class="code" href="classrttr_1_1type.html">type</a> get_type() <span class="keyword">const</span> RTTR_NOEXCEPT;</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> </div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <a class="code" href="classrttr_1_1type.html">type</a> get_declaring_type() <span class="keyword">const</span> RTTR_NOEXCEPT;</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> </div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  <span class="keywordtype">bool</span> set_value(<a class="code" href="classrttr_1_1instance.html">instance</a> <span class="keywordtype">object</span>, <a class="code" href="classrttr_1_1argument.html">argument</a> arg) <span class="keyword">const</span>;</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> </div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  <a class="code" href="classrttr_1_1variant.html">variant</a> get_value(<a class="code" href="classrttr_1_1instance.html">instance</a> <span class="keywordtype">object</span>) <span class="keyword">const</span>;</div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> </div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <a class="code" href="classrttr_1_1variant.html">variant</a> get_metadata(<span class="keyword">const</span> <a class="code" href="classrttr_1_1variant.html">variant</a>& key) <span class="keyword">const</span>;</div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> </div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  <span class="keywordtype">bool</span> <a class="code" href="namespacerttr.html#a4a12343f43cbacffc32270264c6d57c9">operator==</a>(<span class="keyword">const</span> <a class="code" href="classrttr_1_1property.html">property</a>& other) <span class="keyword">const</span> RTTR_NOEXCEPT;</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span> </div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  <span class="keywordtype">bool</span> <a class="code" href="namespacerttr.html#a0abd793e9a1346ca80ca4783b7460685">operator!=</a>(<span class="keyword">const</span> <a class="code" href="classrttr_1_1property.html">property</a>& other) <span class="keyword">const</span> RTTR_NOEXCEPT;</div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> </div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  <a class="code" href="classrttr_1_1property.html">property</a>(<span class="keyword">const</span> detail::property_wrapper_base* wrapper) RTTR_NOEXCEPT;</div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span> </div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  <span class="keyword">friend</span> T detail::create_item(<span class="keyword">const</span> detail::class_item_to_wrapper_t<T>* wrapper);</div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  <span class="keyword">friend</span> T detail::create_invalid_item();</div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span> </div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  <span class="keyword">const</span> detail::property_wrapper_base* m_wrapper;</div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span> };</div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> </div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span> } <span class="comment">// end namespace rttr</span></div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> </div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="preprocessor">#endif // RTTR_PROPERTY_H_</span></div><div class="ttc" id="namespacerttr_html"><div class="ttname"><a href="namespacerttr.html">rttr</a></div><div class="ttdef"><b>Definition:</b> access_levels.h:33</div></div> <div class="ttc" id="classrttr_1_1type_html"><div class="ttname"><a href="classrttr_1_1type.html">rttr::type</a></div><div class="ttdoc">The type class holds the type information for any arbitrary object.</div><div class="ttdef"><b>Definition:</b> type.h:170</div></div> <div class="ttc" id="parameter__info_8h_html"><div class="ttname"><a href="parameter__info_8h.html">parameter_info.h</a></div></div> <div class="ttc" id="namespacerttr_html_a4a12343f43cbacffc32270264c6d57c9"><div class="ttname"><a href="namespacerttr.html#a4a12343f43cbacffc32270264c6d57c9">rttr::operator==</a></div><div class="ttdeci">constexpr bool operator==(basic_string_view< CharT, Traits > lhs, basic_string_view< CharT, Traits > rhs) noexcept</div><div class="ttdoc">Compares the two views lhs and rhs.</div></div> <div class="ttc" id="classrttr_1_1instance_html"><div class="ttname"><a href="classrttr_1_1instance.html">rttr::instance</a></div><div class="ttdoc">The instance class is used for forwarding the instance of an object to invoke a property or method.</div><div class="ttdef"><b>Definition:</b> instance.h:47</div></div> <div class="ttc" id="classrttr_1_1enumeration_html"><div class="ttname"><a href="classrttr_1_1enumeration.html">rttr::enumeration</a></div><div class="ttdoc">The enumeration class provides several meta information about an enum.</div><div class="ttdef"><b>Definition:</b> enumeration.h:112</div></div> <div class="ttc" id="namespacerttr_html_aa07db0e4984d0c48adc5d61f834d611b"><div class="ttname"><a href="namespacerttr.html#aa07db0e4984d0c48adc5d61f834d611b">rttr::access_levels</a></div><div class="ttdeci">access_levels</div><div class="ttdoc">The access_levels enum represents the three access modifiers, which can be used in classes to encapsu...</div><div class="ttdef"><b>Definition:</b> access_levels.h:45</div></div> <div class="ttc" id="namespacerttr_html_a0abd793e9a1346ca80ca4783b7460685"><div class="ttname"><a href="namespacerttr.html#a0abd793e9a1346ca80ca4783b7460685">rttr::operator!=</a></div><div class="ttdeci">constexpr bool operator!=(basic_string_view< CharT, Traits > lhs, basic_string_view< CharT, Traits > rhs) noexcept</div><div class="ttdoc">Compares the two views lhs and rhs.</div></div> <div class="ttc" id="string__view_8h_html"><div class="ttname"><a href="string__view_8h.html">string_view.h</a></div></div> <div class="ttc" id="classrttr_1_1basic__string__view_html"><div class="ttname"><a href="classrttr_1_1basic__string__view.html">rttr::basic_string_view</a></div><div class="ttdoc">The class template basic_string_view describes an non-owning reference to a constant contiguous seque...</div><div class="ttdef"><b>Definition:</b> string_view.h:48</div></div> <div class="ttc" id="classrttr_1_1argument_html"><div class="ttname"><a href="classrttr_1_1argument.html">rttr::argument</a></div><div class="ttdoc">The argument class is used for forwarding arguments to properties or methods.</div><div class="ttdef"><b>Definition:</b> argument.h:51</div></div> <div class="ttc" id="classrttr_1_1property_html"><div class="ttname"><a href="classrttr_1_1property.html">rttr::property</a></div><div class="ttdoc">The property class provides several meta information about a property and gives read/write access to ...</div><div class="ttdef"><b>Definition:</b> property.h:116</div></div> <div class="ttc" id="classrttr_1_1variant_html"><div class="ttname"><a href="classrttr_1_1variant.html">rttr::variant</a></div><div class="ttdoc">The variant class allows to store data of any type and convert between these types transparently.</div><div class="ttdef"><b>Definition:</b> variant.h:197</div></div> <div class="ttc" id="access__levels_8h_html"><div class="ttname"><a href="access__levels_8h.html">access_levels.h</a></div></div> </div><!-- fragment --></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:56 for rttr - 0.9.6 by <a href="http://www.doxygen.org/index.html">doxygen</a>. </small> </address> </body> </html>