<!-- 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::enumeration 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_1enumeration.html">enumeration</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classrttr_1_1enumeration-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">rttr::enumeration Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="classrttr_1_1enumeration.html">enumeration</a> class provides several meta information about an enum.
<a href="classrttr_1_1enumeration.html#details">More...</a></p>
<p><code>#include <<a class="el" href="enumeration_8h_source.html">enumeration.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:a9d9e7310690f28ed7bee8e67ccaa466b"><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_1enumeration.html#a9d9e7310690f28ed7bee8e67ccaa466b">get_declaring_type</a> () const noexcept</td></tr>
<tr class="memdesc:a9d9e7310690f28ed7bee8e67ccaa466b"><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 <a class="el" href="classrttr_1_1enumeration.html">enumeration</a>. <a href="#a9d9e7310690f28ed7bee8e67ccaa466b">More...</a><br /></td></tr>
<tr class="separator:a9d9e7310690f28ed7bee8e67ccaa466b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1006bfdd05b068acdf18930ad45a3367"><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_1enumeration.html#a1006bfdd05b068acdf18930ad45a3367">get_metadata</a> (const <a class="el" href="classrttr_1_1variant.html">variant</a> &key) const</td></tr>
<tr class="memdesc:a1006bfdd05b068acdf18930ad45a3367"><td class="mdescLeft"> </td><td class="mdescRight">Returns the meta data for the given key <code>key</code>. <a href="#a1006bfdd05b068acdf18930ad45a3367">More...</a><br /></td></tr>
<tr class="separator:a1006bfdd05b068acdf18930ad45a3367"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8e3c2784524fb18ab1486277da5ffb49"><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_1enumeration.html#a8e3c2784524fb18ab1486277da5ffb49">get_name</a> () const noexcept</td></tr>
<tr class="memdesc:a8e3c2784524fb18ab1486277da5ffb49"><td class="mdescLeft"> </td><td class="mdescRight">Returns the declared name of this <a class="el" href="classrttr_1_1enumeration.html">enumeration</a>. <a href="#a8e3c2784524fb18ab1486277da5ffb49">More...</a><br /></td></tr>
<tr class="separator:a8e3c2784524fb18ab1486277da5ffb49"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b82fbd3fa31da2e0073a127aea26e5c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classrttr_1_1array__range.html">array_range</a>< <a class="el" href="namespacerttr.html#a61265f69675ac438ecfa23b084adaa56">string_view</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1enumeration.html#a6b82fbd3fa31da2e0073a127aea26e5c">get_names</a> () const noexcept</td></tr>
<tr class="memdesc:a6b82fbd3fa31da2e0073a127aea26e5c"><td class="mdescLeft"> </td><td class="mdescRight">Returns all enum names registered for this enumeration. <a href="#a6b82fbd3fa31da2e0073a127aea26e5c">More...</a><br /></td></tr>
<tr class="separator:a6b82fbd3fa31da2e0073a127aea26e5c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2277edecf9eb96ae375f97e08470c804"><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_1enumeration.html#a2277edecf9eb96ae375f97e08470c804">get_type</a> () const noexcept</td></tr>
<tr class="memdesc:a2277edecf9eb96ae375f97e08470c804"><td class="mdescLeft"> </td><td class="mdescRight">Returns the type object of this <a class="el" href="classrttr_1_1enumeration.html">enumeration</a>. <a href="#a2277edecf9eb96ae375f97e08470c804">More...</a><br /></td></tr>
<tr class="separator:a2277edecf9eb96ae375f97e08470c804"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9bdc3cda7b1fc15475a756e3b96715c6"><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_1enumeration.html#a9bdc3cda7b1fc15475a756e3b96715c6">get_underlying_type</a> () const noexcept</td></tr>
<tr class="memdesc:a9bdc3cda7b1fc15475a756e3b96715c6"><td class="mdescLeft"> </td><td class="mdescRight">Returns the underlying type (int, unsigned int, etc.) of this <a class="el" href="classrttr_1_1enumeration.html">enumeration</a>. <a href="#a9bdc3cda7b1fc15475a756e3b96715c6">More...</a><br /></td></tr>
<tr class="separator:a9bdc3cda7b1fc15475a756e3b96715c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7906e4cde102860cdc68db1da6172a41"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classrttr_1_1array__range.html">array_range</a>< <a class="el" href="classrttr_1_1variant.html">variant</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1enumeration.html#a7906e4cde102860cdc68db1da6172a41">get_values</a> () const noexcept</td></tr>
<tr class="memdesc:a7906e4cde102860cdc68db1da6172a41"><td class="mdescLeft"> </td><td class="mdescRight">Returns all enum values registered for this enumeration. <a href="#a7906e4cde102860cdc68db1da6172a41">More...</a><br /></td></tr>
<tr class="separator:a7906e4cde102860cdc68db1da6172a41"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a465644dd0af25f6d55cd17704c4e6137"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1enumeration.html#a465644dd0af25f6d55cd17704c4e6137">is_valid</a> () const noexcept</td></tr>
<tr class="memdesc:a465644dd0af25f6d55cd17704c4e6137"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this <a class="el" href="classrttr_1_1enumeration.html">enumeration</a> is valid, otherwise false. <a href="#a465644dd0af25f6d55cd17704c4e6137">More...</a><br /></td></tr>
<tr class="separator:a465644dd0af25f6d55cd17704c4e6137"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae5c72df6db7319bcd85b52a689e72dfd"><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_1enumeration.html#ae5c72df6db7319bcd85b52a689e72dfd">name_to_value</a> (<a class="el" href="namespacerttr.html#a61265f69675ac438ecfa23b084adaa56">string_view</a> name) const</td></tr>
<tr class="memdesc:ae5c72df6db7319bcd85b52a689e72dfd"><td class="mdescLeft"> </td><td class="mdescRight">Returns the value of the given enumeration <code>name</code>, or an empty variant if the name is not defined. <a href="#ae5c72df6db7319bcd85b52a689e72dfd">More...</a><br /></td></tr>
<tr class="separator:ae5c72df6db7319bcd85b52a689e72dfd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a21189030f56f8d1b0b767194004dad8d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1enumeration.html#a21189030f56f8d1b0b767194004dad8d">operator bool</a> () const noexcept</td></tr>
<tr class="memdesc:a21189030f56f8d1b0b767194004dad8d"><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to check if this <a class="el" href="classrttr_1_1enumeration.html">enumeration</a> is valid or not. <a href="#a21189030f56f8d1b0b767194004dad8d">More...</a><br /></td></tr>
<tr class="separator:a21189030f56f8d1b0b767194004dad8d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4c5fb46e51e09b7fd0a850e197075c87"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1enumeration.html#a4c5fb46e51e09b7fd0a850e197075c87">operator!=</a> (const <a class="el" href="classrttr_1_1enumeration.html">enumeration</a> &other) const noexcept</td></tr>
<tr class="memdesc:a4c5fb46e51e09b7fd0a850e197075c87"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this enumeration is the not the same like the <code>other</code>. <a href="#a4c5fb46e51e09b7fd0a850e197075c87">More...</a><br /></td></tr>
<tr class="separator:a4c5fb46e51e09b7fd0a850e197075c87"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e76b60ca07d2582e5491758e113e24c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classrttr_1_1enumeration.html#a4e76b60ca07d2582e5491758e113e24c">operator==</a> (const <a class="el" href="classrttr_1_1enumeration.html">enumeration</a> &other) const noexcept</td></tr>
<tr class="memdesc:a4e76b60ca07d2582e5491758e113e24c"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this enumeration is the same like the <code>other</code>. <a href="#a4e76b60ca07d2582e5491758e113e24c">More...</a><br /></td></tr>
<tr class="separator:a4e76b60ca07d2582e5491758e113e24c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a250cafc29edef91c37dda0cd3e0334ce"><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_1enumeration.html#a250cafc29edef91c37dda0cd3e0334ce">value_to_name</a> (<a class="el" href="classrttr_1_1argument.html">argument</a> <a class="el" href="namespacerttr.html#a54ecd8bad715cbc451e7aa8491667d4a">value</a>) const</td></tr>
<tr class="memdesc:a250cafc29edef91c37dda0cd3e0334ce"><td class="mdescLeft"> </td><td class="mdescRight">Returns the string_view that is used as the name of the given enumeration <code>value</code>, or an empty string_view if the <code>value</code> is not defined. <a href="#a250cafc29edef91c37dda0cd3e0334ce">More...</a><br /></td></tr>
<tr class="separator:a250cafc29edef91c37dda0cd3e0334ce"><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_1enumeration.html">enumeration</a> class provides several meta information about an enum. </p>
<p>A instance of an enumeration class can only be obtained from the <a class="el" href="classrttr_1_1type.html">type</a> class or the <a class="el" href="classrttr_1_1property.html">property</a> class. See <a class="el" href="classrttr_1_1type.html#aa0b0e3e85de99df74f956a84b463f10b">type::get_enumeration()</a> and <a class="el" href="classrttr_1_1property.html#a8505269e5b2d12c69ffec3c2bdca4e51">property::get_enumeration()</a>.</p>
<p>For registration an enum, nested inside a class, see <a class="el" href="classrttr_1_1registration_1_1class__.html#ad4f37155a55668afd8fcb66441f3ef88">registration::class_<T>::enumeration()</a> and for global enums see <a class="el" href="classrttr_1_1registration.html#ae185f4e001154c4d95a3901bcbd6e234">registration::enumeration()</a>.</p>
<h2>Meta Information </h2>
<p>An <a class="el" href="classrttr_1_1enumeration.html">enumeration</a> is described by it's declared name (<a class="el" href="classrttr_1_1enumeration.html#a8e3c2784524fb18ab1486277da5ffb49">get_name()</a>), it's enumerator names (<a class="el" href="classrttr_1_1enumeration.html#a6b82fbd3fa31da2e0073a127aea26e5c">get_names()</a>) and it's corresponding constant values (<a class="el" href="classrttr_1_1enumeration.html#a7906e4cde102860cdc68db1da6172a41">get_values()</a>). The name is represented as <a class="el" href="namespacerttr.html#a61265f69675ac438ecfa23b084adaa56">string_view</a> and the values are stored as the underlying enum value. When the <a class="el" href="classrttr_1_1enumeration.html">enumeration</a> was declared inside a class, then <a class="el" href="classrttr_1_1enumeration.html#a9d9e7310690f28ed7bee8e67ccaa466b">get_declaring_type()</a> can be used to obtain the type of this class.</p>
<p>The conversion functions <a class="el" href="classrttr_1_1enumeration.html#ae5c72df6db7319bcd85b52a689e72dfd">name_to_value()</a>, <a class="el" href="classrttr_1_1enumeration.html#a250cafc29edef91c37dda0cd3e0334ce">value_to_name()</a> allow conversion between the value representation of an enumeration and its literal representation.</p>
<h2>Copying and Assignment </h2>
<p>A <a class="el" href="classrttr_1_1enumeration.html">enumeration</a> object is lightweight and can be copied by value. However, each copy will refer to the same underlying enumeration.</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">enum class</span> E_Alignment</div><div class="line">{</div><div class="line"> AlignLeft = 0x0001,</div><div class="line"> AlignRight = 0x0002,</div><div class="line"> AlignHCenter = 0x0004,</div><div class="line"> AlignJustify = 0x0008</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"> rttr::registration::enumeration<E_Alignment>(<span class="stringliteral">"E_Alignment"</span>)</div><div class="line"> (</div><div class="line"> <a class="code" href="namespacerttr.html#a54ecd8bad715cbc451e7aa8491667d4a">value</a>(<span class="stringliteral">"AlignLeft"</span>, E_Alignment::AlignLeft),</div><div class="line"> <a class="code" href="namespacerttr.html#a54ecd8bad715cbc451e7aa8491667d4a">value</a>(<span class="stringliteral">"AlignRight"</span>, E_Alignment::AlignRight),</div><div class="line"> <a class="code" href="namespacerttr.html#a54ecd8bad715cbc451e7aa8491667d4a">value</a>(<span class="stringliteral">"AlignHCenter"</span>, E_Alignment::AlignHCenter),</div><div class="line"> <a class="code" href="namespacerttr.html#a54ecd8bad715cbc451e7aa8491667d4a">value</a>(<span class="stringliteral">"AlignJustify"</span>, E_Alignment::AlignJustify)</div><div class="line"> );</div><div class="line">}</div><div class="line"></div><div class="line"><a class="code" href="classrttr_1_1enumeration.html">enumeration</a> enum_align = <a class="code" href="classrttr_1_1type.html#a7ba79b9f4916c30db74fe65508dca033">type::get_by_name</a>(<span class="stringliteral">"E_Alignment"</span>).<a class="code" href="classrttr_1_1type.html#aa0b0e3e85de99df74f956a84b463f10b">get_enumeration</a>();</div><div class="line"><span class="keywordflow">if</span> (enum_align)</div><div class="line">{</div><div class="line"> E_Alignment enum_value = E_Alignment::AlignLeft;</div><div class="line"> <a class="code" href="classrttr_1_1basic__string__view.html">string_view</a> name = enum_align.<a class="code" href="classrttr_1_1enumeration.html#a250cafc29edef91c37dda0cd3e0334ce">value_to_name</a>(enum_value);</div><div class="line"> std::cout << name; <span class="comment">// prints "AlignLeft"</span></div><div class="line"></div><div class="line"> <a class="code" href="classrttr_1_1variant.html">variant</a> var = enum_align.<a class="code" href="classrttr_1_1enumeration.html#ae5c72df6db7319bcd85b52a689e72dfd">name_to_value</a>(<span class="stringliteral">"AlignJustify"</span>);</div><div class="line"> enum_value = var.<a class="code" href="classrttr_1_1variant.html#aa3a9f7e07cdc4d922a4e09882c5c0574">get_value</a><E_Alignment>(); <span class="comment">// is now: "AlignJustify"</span></div><div class="line"> std::cout << var.<a class="code" href="classrttr_1_1variant.html#ae5acffcd7dcbe87d0d976e37a815ab43">to_int</a>(); <span class="comment">// prints "8";</span></div><div class="line"> std::cout << var.<a class="code" href="classrttr_1_1variant.html#a28bab1ccff5776d2f713b7a2543167a9">to_string</a>(); <span class="comment">// prints "AlignJustify";</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_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_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="a9d9e7310690f28ed7bee8e67ccaa466b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d9e7310690f28ed7bee8e67ccaa466b">◆ </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::enumeration::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 <a class="el" href="classrttr_1_1enumeration.html">enumeration</a>. </p>
<dl class="section remark"><dt>Remarks</dt><dd>When this enumeration does not belong to a class (i.e. is a global enumeration) it will return an invalid type object. When this enumeration 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 enumeration. </dd></dl>
</div>
</div>
<a id="a1006bfdd05b068acdf18930ad45a3367"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1006bfdd05b068acdf18930ad45a3367">◆ </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::enumeration::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="a8e3c2784524fb18ab1486277da5ffb49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e3c2784524fb18ab1486277da5ffb49">◆ </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::enumeration::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 declared name of this <a class="el" href="classrttr_1_1enumeration.html">enumeration</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>Name of the <a class="el" href="classrttr_1_1enumeration.html">enumeration</a>. </dd></dl>
</div>
</div>
<a id="a6b82fbd3fa31da2e0073a127aea26e5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b82fbd3fa31da2e0073a127aea26e5c">◆ </a></span>get_names()</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_1array__range.html">array_range</a><<a class="el" href="namespacerttr.html#a61265f69675ac438ecfa23b084adaa56">string_view</a>> rttr::enumeration::get_names </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 all enum names registered for this enumeration. </p>
<dl class="section remark"><dt>Remarks</dt><dd>When the enumeration is invalid then an empty range is returned.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>A range of enumeration names. </dd></dl>
</div>
</div>
<a id="a2277edecf9eb96ae375f97e08470c804"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2277edecf9eb96ae375f97e08470c804">◆ </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::enumeration::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 type object of this <a class="el" href="classrttr_1_1enumeration.html">enumeration</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>Data type of the <a class="el" href="classrttr_1_1enumeration.html">enumeration</a>. </dd></dl>
</div>
</div>
<a id="a9bdc3cda7b1fc15475a756e3b96715c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9bdc3cda7b1fc15475a756e3b96715c6">◆ </a></span>get_underlying_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::enumeration::get_underlying_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 type (int, unsigned int, etc.) of this <a class="el" href="classrttr_1_1enumeration.html">enumeration</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>Data type of the <a class="el" href="classrttr_1_1enumeration.html">enumeration</a>. </dd></dl>
</div>
</div>
<a id="a7906e4cde102860cdc68db1da6172a41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7906e4cde102860cdc68db1da6172a41">◆ </a></span>get_values()</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_1array__range.html">array_range</a><<a class="el" href="classrttr_1_1variant.html">variant</a>> rttr::enumeration::get_values </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 all enum values registered for this enumeration. </p>
<dl class="section remark"><dt>Remarks</dt><dd>When the enumeration is invalid then an empty range is returned.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>A range of enumeration values. </dd></dl>
</div>
</div>
<a id="a465644dd0af25f6d55cd17704c4e6137"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a465644dd0af25f6d55cd17704c4e6137">◆ </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::enumeration::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 <a class="el" href="classrttr_1_1enumeration.html">enumeration</a> is valid, otherwise false. </p>
<dl class="section return"><dt>Returns</dt><dd>True if this <a class="el" href="classrttr_1_1enumeration.html">enumeration</a> is valid, otherwise false. </dd></dl>
</div>
</div>
<a id="ae5c72df6db7319bcd85b52a689e72dfd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5c72df6db7319bcd85b52a689e72dfd">◆ </a></span>name_to_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::enumeration::name_to_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacerttr.html#a61265f69675ac438ecfa23b084adaa56">string_view</a> </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the value of the given enumeration <code>name</code>, or an empty variant if the name is not defined. </p>
<dl class="section return"><dt>Returns</dt><dd>A variant object, containing the value for the given <code>name</code>. </dd></dl>
</div>
</div>
<a id="a21189030f56f8d1b0b767194004dad8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21189030f56f8d1b0b767194004dad8d">◆ </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::enumeration::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 <a class="el" href="classrttr_1_1enumeration.html">enumeration</a> is valid or not. </p>
<dl class="section return"><dt>Returns</dt><dd>True if this <a class="el" href="classrttr_1_1enumeration.html">enumeration</a> is valid, otherwise false. </dd></dl>
</div>
</div>
<a id="a4c5fb46e51e09b7fd0a850e197075c87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c5fb46e51e09b7fd0a850e197075c87">◆ </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::enumeration::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classrttr_1_1enumeration.html">enumeration</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 enumeration is the not the same like the <code>other</code>. </p>
<dl class="section return"><dt>Returns</dt><dd>True if both enumerations are different, otherwise false. </dd></dl>
</div>
</div>
<a id="a4e76b60ca07d2582e5491758e113e24c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e76b60ca07d2582e5491758e113e24c">◆ </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::enumeration::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classrttr_1_1enumeration.html">enumeration</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 enumeration is the same like the <code>other</code>. </p>
<dl class="section return"><dt>Returns</dt><dd>True if both enumerations are equal, otherwise false. </dd></dl>
</div>
</div>
<a id="a250cafc29edef91c37dda0cd3e0334ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a250cafc29edef91c37dda0cd3e0334ce">◆ </a></span>value_to_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacerttr.html#a61265f69675ac438ecfa23b084adaa56">string_view</a> rttr::enumeration::value_to_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classrttr_1_1argument.html">argument</a> </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the string_view that is used as the name of the given enumeration <code>value</code>, or an empty string_view if the <code>value</code> is not defined. </p>
<dl class="section return"><dt>Returns</dt><dd>A string_view object, containing the name for the given value. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="enumeration_8h_source.html">enumeration.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
>
191
