| <!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> |
| <link rel="canonical" href="https://ignite.apache.org/releases/2.8.0/cppdoc/classignite_1_1binary_1_1BinaryEnumEntry.html" /> |
| <META NAME="ROBOTS" CONTENT="NOINDEX"> |
| |
| |
| |
| <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.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title> Apache Ignite C++: ignite::binary::BinaryEnumEntry Class Reference</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" /> |
| |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-61232409-1', 'auto'); |
| ga('send', 'pageview'); |
| |
| </script></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"> Apache Ignite C++ |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </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="namespaceignite.html">ignite</a></li><li class="navelem"><a class="el" href="namespaceignite_1_1binary.html">binary</a></li><li class="navelem"><a class="el" href="classignite_1_1binary_1_1BinaryEnumEntry.html">BinaryEnumEntry</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classignite_1_1binary_1_1BinaryEnumEntry-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">ignite::binary::BinaryEnumEntry Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Binary enum entry. |
| <a href="classignite_1_1binary_1_1BinaryEnumEntry.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="binary__enum__entry_8h_source.html">binary_enum_entry.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:a3b9c6c381c6d4cf74171c4a23ac29767"><td class="memItemLeft" align="right" valign="top"><a id="a3b9c6c381c6d4cf74171c4a23ac29767"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryEnumEntry.html#a3b9c6c381c6d4cf74171c4a23ac29767">BinaryEnumEntry</a> ()</td></tr> |
| <tr class="memdesc:a3b9c6c381c6d4cf74171c4a23ac29767"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr> |
| <tr class="separator:a3b9c6c381c6d4cf74171c4a23ac29767"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afc1e17cca4fda509e4fbdfc36223cd3d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryEnumEntry.html#afc1e17cca4fda509e4fbdfc36223cd3d">BinaryEnumEntry</a> (int32_t typeId, int32_t ordinal)</td></tr> |
| <tr class="memdesc:afc1e17cca4fda509e4fbdfc36223cd3d"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#afc1e17cca4fda509e4fbdfc36223cd3d">More...</a><br /></td></tr> |
| <tr class="separator:afc1e17cca4fda509e4fbdfc36223cd3d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1f1c7da6d7eeab22d8ecfdfc556de6ab"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryEnumEntry.html#a1f1c7da6d7eeab22d8ecfdfc556de6ab">GetTypeId</a> () const</td></tr> |
| <tr class="memdesc:a1f1c7da6d7eeab22d8ecfdfc556de6ab"><td class="mdescLeft"> </td><td class="mdescRight">Get type ID. <a href="#a1f1c7da6d7eeab22d8ecfdfc556de6ab">More...</a><br /></td></tr> |
| <tr class="separator:a1f1c7da6d7eeab22d8ecfdfc556de6ab"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af826788f98df7ae52be7d8f75ce34836"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryEnumEntry.html#af826788f98df7ae52be7d8f75ce34836">GetOrdinal</a> () const</td></tr> |
| <tr class="memdesc:af826788f98df7ae52be7d8f75ce34836"><td class="mdescLeft"> </td><td class="mdescRight">Get ordinal of the enum value. <a href="#af826788f98df7ae52be7d8f75ce34836">More...</a><br /></td></tr> |
| <tr class="separator:af826788f98df7ae52be7d8f75ce34836"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1c6d52ed42e3e6fe023e4bf5de306f5b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryEnumEntry.html#a1c6d52ed42e3e6fe023e4bf5de306f5b">IsNull</a> () const</td></tr> |
| <tr class="memdesc:a1c6d52ed42e3e6fe023e4bf5de306f5b"><td class="mdescLeft"> </td><td class="mdescRight">Check whether value was acquired by reading a NULL value. <a href="#a1c6d52ed42e3e6fe023e4bf5de306f5b">More...</a><br /></td></tr> |
| <tr class="separator:a1c6d52ed42e3e6fe023e4bf5de306f5b"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Binary enum entry. </p> |
| <p>Represents a single entry of enum in a binary form. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="afc1e17cca4fda509e4fbdfc36223cd3d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afc1e17cca4fda509e4fbdfc36223cd3d">◆ </a></span>BinaryEnumEntry()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">ignite::binary::BinaryEnumEntry::BinaryEnumEntry </td> |
| <td>(</td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>typeId</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>ordinal</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Constructor. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">typeId</td><td>Type ID of the enum. </td></tr> |
| <tr><td class="paramname">ordinal</td><td>Ordinal of the enum value. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="af826788f98df7ae52be7d8f75ce34836"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af826788f98df7ae52be7d8f75ce34836">◆ </a></span>GetOrdinal()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int32_t ignite::binary::BinaryEnumEntry::GetOrdinal </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">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get ordinal of the enum value. </p> |
| <dl class="section return"><dt>Returns</dt><dd>Ordinal. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a1f1c7da6d7eeab22d8ecfdfc556de6ab"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1f1c7da6d7eeab22d8ecfdfc556de6ab">◆ </a></span>GetTypeId()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int32_t ignite::binary::BinaryEnumEntry::GetTypeId </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">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get type ID. </p> |
| <p>Type ID can never equal zero. If the Type ID equals zero, the instance is not valid, and could only be acquired by manual construction or by reading NULL value.</p> |
| <dl class="section return"><dt>Returns</dt><dd>Type ID. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a1c6d52ed42e3e6fe023e4bf5de306f5b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1c6d52ed42e3e6fe023e4bf5de306f5b">◆ </a></span>IsNull()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool ignite::binary::BinaryEnumEntry::IsNull </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">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Check whether value was acquired by reading a NULL value. </p> |
| <dl class="section return"><dt>Returns</dt><dd><code>true</code> if acquired by reading a NULL value. </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li><a class="el" href="binary__enum__entry_8h_source.html">binary_enum_entry.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Feb 27 2020 14:01:15 for Apache Ignite C++ by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |