blob: e21c828f796b18dd7a30cbd531159ecb3bd04eeb [file] [log] [blame]
<!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="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>&nbsp; Apache Ignite C++: ignite::binary::BinaryEnum&lt; T &gt; Struct Template 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" />
</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.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="structignite_1_1binary_1_1BinaryEnum.html">BinaryEnum</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">ignite::binary::BinaryEnum&lt; T &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Binary enum structure.
<a href="structignite_1_1binary_1_1BinaryEnum.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="binary__enum_8h_source.html">binary_enum.h</a>&gt;</code></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename T&gt;<br />
struct ignite::binary::BinaryEnum&lt; T &gt;</h3>
<p>Binary enum structure. </p>
<p>Defines a set of functions required for enum type to be serialized and deserialized.</p>
<p>Methods that should be defined: static void GetTypeName(std::string&amp; dst) - should place type name in <code>dst</code> parameter. This method should always return the same value. static int32_t GetTypeId() - should return Type ID. static int32_t GetOrdinal(T) - should return ordinal value for enum value. static T FromOrdinal(int32_t) - should return enum value for a given ordinal value. static bool IsNull(const T&amp;) - check whether passed enum object should be interpreted as NULL. static void GetNull(T&amp;) - get NULL value for the given enum type.</p>
<p>It is recommended to use <a class="el" href="structignite_1_1binary_1_1BinaryEnumDefault.html" title="Default implementations of BinaryEnum. ">BinaryEnumDefault</a> as a base class for default implementation of GetTypeId(), GetOrdinal() and FromOrdinal() methods for plain enum types. In this case, only GetTypeName() should be implemented by a user directly. </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="binary__enum_8h_source.html">binary_enum.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Sep 11 2021 21:14:00 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.13
</small></address>
</body>
</html>