blob: fe9129ee82b00292871eef108c47e282269a4b81 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>&nbsp; Apache Ignite C++: binary_enum_entry.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="ignite_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">&nbsp; Apache Ignite C++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<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&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_88bd599177f4cc5007b9f053025b0bc5.html">binary</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">binary_enum_entry.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="binary__enum__entry_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>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * this work for additional information regarding copyright ownership.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * (the &quot;License&quot;); you may not use this file except in compliance with</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * limitations under the License.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#ifndef _IGNITE_BINARY_BINARY_ENUM_ENTRY</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#define _IGNITE_BINARY_BINARY_ENUM_ENTRY</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &lt;ignite/common/common.h&gt;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceignite.html">ignite</a></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;{</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">namespace </span>binary</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; {</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classignite_1_1binary_1_1BinaryEnumEntry.html"> 39</a></span>&#160; <span class="keyword">class </span>IGNITE_IMPORT_EXPORT <a class="code" href="classignite_1_1binary_1_1BinaryEnumEntry.html">BinaryEnumEntry</a></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classignite_1_1binary_1_1BinaryEnumEntry.html#a3b9c6c381c6d4cf74171c4a23ac29767"> 45</a></span>&#160; <a class="code" href="classignite_1_1binary_1_1BinaryEnumEntry.html#a3b9c6c381c6d4cf74171c4a23ac29767">BinaryEnumEntry</a>() :</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; typeId(0),</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; ordinal(0)</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; {</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="comment">// No-op.</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; }</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classignite_1_1binary_1_1BinaryEnumEntry.html#afc1e17cca4fda509e4fbdfc36223cd3d"> 58</a></span>&#160; <a class="code" href="classignite_1_1binary_1_1BinaryEnumEntry.html#afc1e17cca4fda509e4fbdfc36223cd3d">BinaryEnumEntry</a>(int32_t typeId, int32_t ordinal) :</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; typeId(typeId),</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; ordinal(ordinal)</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; {</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="comment">// No-op.</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; }</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="classignite_1_1binary_1_1BinaryEnumEntry.html#a1f1c7da6d7eeab22d8ecfdfc556de6ab"> 72</a></span>&#160; int32_t <a class="code" href="classignite_1_1binary_1_1BinaryEnumEntry.html#a1f1c7da6d7eeab22d8ecfdfc556de6ab">GetTypeId</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordflow">return</span> typeId;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; }</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
<div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="classignite_1_1binary_1_1BinaryEnumEntry.html#af826788f98df7ae52be7d8f75ce34836"> 82</a></span>&#160; int32_t <a class="code" href="classignite_1_1binary_1_1BinaryEnumEntry.html#af826788f98df7ae52be7d8f75ce34836">GetOrdinal</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keywordflow">return</span> ordinal;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; }</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; </div>
<div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="classignite_1_1binary_1_1BinaryEnumEntry.html#a1c6d52ed42e3e6fe023e4bf5de306f5b"> 92</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classignite_1_1binary_1_1BinaryEnumEntry.html#a1c6d52ed42e3e6fe023e4bf5de306f5b">IsNull</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordflow">return</span> typeId == 0;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; }</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; int32_t typeId;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; int32_t ordinal;</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; };</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; }</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;}</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;<span class="preprocessor">#endif //_IGNITE_BINARY_BINARY_ENUM_ENTRY</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="anamespaceignite_html"><div class="ttname"><a href="namespaceignite.html">ignite</a></div><div class="ttdoc">Apache Ignite API.</div><div class="ttdef"><b>Definition:</b> cache.h:48</div></div>
<div class="ttc" id="aclassignite_1_1binary_1_1BinaryEnumEntry_html_af826788f98df7ae52be7d8f75ce34836"><div class="ttname"><a href="classignite_1_1binary_1_1BinaryEnumEntry.html#af826788f98df7ae52be7d8f75ce34836">ignite::binary::BinaryEnumEntry::GetOrdinal</a></div><div class="ttdeci">int32_t GetOrdinal() const</div><div class="ttdoc">Get ordinal of the enum value.</div><div class="ttdef"><b>Definition:</b> binary_enum_entry.h:82</div></div>
<div class="ttc" id="aclassignite_1_1binary_1_1BinaryEnumEntry_html_a1c6d52ed42e3e6fe023e4bf5de306f5b"><div class="ttname"><a href="classignite_1_1binary_1_1BinaryEnumEntry.html#a1c6d52ed42e3e6fe023e4bf5de306f5b">ignite::binary::BinaryEnumEntry::IsNull</a></div><div class="ttdeci">bool IsNull() const</div><div class="ttdoc">Check whether value was acquired by reading a NULL value.</div><div class="ttdef"><b>Definition:</b> binary_enum_entry.h:92</div></div>
<div class="ttc" id="aclassignite_1_1binary_1_1BinaryEnumEntry_html_afc1e17cca4fda509e4fbdfc36223cd3d"><div class="ttname"><a href="classignite_1_1binary_1_1BinaryEnumEntry.html#afc1e17cca4fda509e4fbdfc36223cd3d">ignite::binary::BinaryEnumEntry::BinaryEnumEntry</a></div><div class="ttdeci">BinaryEnumEntry(int32_t typeId, int32_t ordinal)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> binary_enum_entry.h:58</div></div>
<div class="ttc" id="aclassignite_1_1binary_1_1BinaryEnumEntry_html_a3b9c6c381c6d4cf74171c4a23ac29767"><div class="ttname"><a href="classignite_1_1binary_1_1BinaryEnumEntry.html#a3b9c6c381c6d4cf74171c4a23ac29767">ignite::binary::BinaryEnumEntry::BinaryEnumEntry</a></div><div class="ttdeci">BinaryEnumEntry()</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> binary_enum_entry.h:45</div></div>
<div class="ttc" id="aclassignite_1_1binary_1_1BinaryEnumEntry_html_a1f1c7da6d7eeab22d8ecfdfc556de6ab"><div class="ttname"><a href="classignite_1_1binary_1_1BinaryEnumEntry.html#a1f1c7da6d7eeab22d8ecfdfc556de6ab">ignite::binary::BinaryEnumEntry::GetTypeId</a></div><div class="ttdeci">int32_t GetTypeId() const</div><div class="ttdoc">Get type ID.</div><div class="ttdef"><b>Definition:</b> binary_enum_entry.h:72</div></div>
<div class="ttc" id="aclassignite_1_1binary_1_1BinaryEnumEntry_html"><div class="ttname"><a href="classignite_1_1binary_1_1BinaryEnumEntry.html">ignite::binary::BinaryEnumEntry</a></div><div class="ttdoc">Binary enum entry.</div><div class="ttdef"><b>Definition:</b> binary_enum_entry.h:39</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jan 10 2022 11:02:04 for &nbsp; Apache Ignite C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>