| <!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> Apache Ignite C++: ignite::binary::BinaryEnum< T * > 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"> 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&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&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="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_3_01T_01_5_01_4.html">BinaryEnum< T * ></a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-types">Public Types</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="structignite_1_1binary_1_1BinaryEnum_3_01T_01_5_01_4-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">ignite::binary::BinaryEnum< T * > Struct Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a class="el" href="structignite_1_1binary_1_1BinaryEnum.html" title="Binary enum structure.">BinaryEnum</a> template specialization for pointers. |
| <a href="structignite_1_1binary_1_1BinaryEnum_3_01T_01_5_01_4.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="binary__enum_8h_source.html">binary_enum.h</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> |
| Public Types</h2></td></tr> |
| <tr class="memitem:a190ddba8542dfae87ae210a92865ffbf"><td class="memItemLeft" align="right" valign="top"><a id="a190ddba8542dfae87ae210a92865ffbf"></a> |
| typedef <a class="el" href="structignite_1_1binary_1_1BinaryEnum.html">BinaryEnum</a>< T > </td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1binary_1_1BinaryEnum_3_01T_01_5_01_4.html#a190ddba8542dfae87ae210a92865ffbf">BinaryEnumDereferenced</a></td></tr> |
| <tr class="memdesc:a190ddba8542dfae87ae210a92865ffbf"><td class="mdescLeft"> </td><td class="mdescRight">Actual type. <br /></td></tr> |
| <tr class="separator:a190ddba8542dfae87ae210a92865ffbf"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:ae7d268e2d84fdc34bdf1c7447a8980e0"><td class="memItemLeft" align="right" valign="top">static int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1binary_1_1BinaryEnum_3_01T_01_5_01_4.html#ae7d268e2d84fdc34bdf1c7447a8980e0">GetTypeId</a> ()</td></tr> |
| <tr class="memdesc:ae7d268e2d84fdc34bdf1c7447a8980e0"><td class="mdescLeft"> </td><td class="mdescRight">Get binary object type ID. <a href="structignite_1_1binary_1_1BinaryEnum_3_01T_01_5_01_4.html#ae7d268e2d84fdc34bdf1c7447a8980e0">More...</a><br /></td></tr> |
| <tr class="separator:ae7d268e2d84fdc34bdf1c7447a8980e0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a09c0f434d55b5c8a7ce5c61d2a4ec939"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1binary_1_1BinaryEnum_3_01T_01_5_01_4.html#a09c0f434d55b5c8a7ce5c61d2a4ec939">GetTypeName</a> (std::string &dst)</td></tr> |
| <tr class="memdesc:a09c0f434d55b5c8a7ce5c61d2a4ec939"><td class="mdescLeft"> </td><td class="mdescRight">Get binary object type name. <a href="structignite_1_1binary_1_1BinaryEnum_3_01T_01_5_01_4.html#a09c0f434d55b5c8a7ce5c61d2a4ec939">More...</a><br /></td></tr> |
| <tr class="separator:a09c0f434d55b5c8a7ce5c61d2a4ec939"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a59a28afa8d81d7ec6457264974e84136"><td class="memItemLeft" align="right" valign="top">static int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1binary_1_1BinaryEnum_3_01T_01_5_01_4.html#a59a28afa8d81d7ec6457264974e84136">GetOrdinal</a> (T *value)</td></tr> |
| <tr class="memdesc:a59a28afa8d81d7ec6457264974e84136"><td class="mdescLeft"> </td><td class="mdescRight">Get enum type ordinal. <a href="structignite_1_1binary_1_1BinaryEnum_3_01T_01_5_01_4.html#a59a28afa8d81d7ec6457264974e84136">More...</a><br /></td></tr> |
| <tr class="separator:a59a28afa8d81d7ec6457264974e84136"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afbc66e7268e86329de27d6da77910999"><td class="memItemLeft" align="right" valign="top">static T * </td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1binary_1_1BinaryEnum_3_01T_01_5_01_4.html#afbc66e7268e86329de27d6da77910999">FromOrdinal</a> (int32_t ordinal)</td></tr> |
| <tr class="memdesc:afbc66e7268e86329de27d6da77910999"><td class="mdescLeft"> </td><td class="mdescRight">Get enum value for the given ordinal value. <a href="structignite_1_1binary_1_1BinaryEnum_3_01T_01_5_01_4.html#afbc66e7268e86329de27d6da77910999">More...</a><br /></td></tr> |
| <tr class="separator:afbc66e7268e86329de27d6da77910999"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5b59c3242d574bb1024f878858f47ac4"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1binary_1_1BinaryEnum_3_01T_01_5_01_4.html#a5b59c3242d574bb1024f878858f47ac4">IsNull</a> (T *const &obj)</td></tr> |
| <tr class="memdesc:a5b59c3242d574bb1024f878858f47ac4"><td class="mdescLeft"> </td><td class="mdescRight">Check whether passed enum should be interpreted as NULL. <a href="structignite_1_1binary_1_1BinaryEnum_3_01T_01_5_01_4.html#a5b59c3242d574bb1024f878858f47ac4">More...</a><br /></td></tr> |
| <tr class="separator:a5b59c3242d574bb1024f878858f47ac4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acb787af46b4d8b7e7e94916e52b5d619"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1binary_1_1BinaryEnum_3_01T_01_5_01_4.html#acb787af46b4d8b7e7e94916e52b5d619">GetNull</a> (T *&dst)</td></tr> |
| <tr class="memdesc:acb787af46b4d8b7e7e94916e52b5d619"><td class="mdescLeft"> </td><td class="mdescRight">Get NULL value for the enum type. <a href="structignite_1_1binary_1_1BinaryEnum_3_01T_01_5_01_4.html#acb787af46b4d8b7e7e94916e52b5d619">More...</a><br /></td></tr> |
| <tr class="separator:acb787af46b4d8b7e7e94916e52b5d619"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><h3>template<typename T><br /> |
| struct ignite::binary::BinaryEnum< T * ></h3> |
| |
| <p><a class="el" href="structignite_1_1binary_1_1BinaryEnum.html" title="Binary enum structure.">BinaryEnum</a> template specialization for pointers. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="afbc66e7268e86329de27d6da77910999"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afbc66e7268e86329de27d6da77910999">◆ </a></span>FromOrdinal()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static T* <a class="el" href="structignite_1_1binary_1_1BinaryEnum.html">ignite::binary::BinaryEnum</a>< T * >::FromOrdinal </td> |
| <td>(</td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>ordinal</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get enum value for the given ordinal value. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">ordinal</td><td>Ordinal value of the enum. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="acb787af46b4d8b7e7e94916e52b5d619"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acb787af46b4d8b7e7e94916e52b5d619">◆ </a></span>GetNull()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static void <a class="el" href="structignite_1_1binary_1_1BinaryEnum.html">ignite::binary::BinaryEnum</a>< T * >::GetNull </td> |
| <td>(</td> |
| <td class="paramtype">T *& </td> |
| <td class="paramname"><em>dst</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get NULL value for the enum type. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">dst</td><td>NULL value for the enum. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a59a28afa8d81d7ec6457264974e84136"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a59a28afa8d81d7ec6457264974e84136">◆ </a></span>GetOrdinal()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static int32_t <a class="el" href="structignite_1_1binary_1_1BinaryEnum.html">ignite::binary::BinaryEnum</a>< T * >::GetOrdinal </td> |
| <td>(</td> |
| <td class="paramtype">T * </td> |
| <td class="paramname"><em>value</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get enum type ordinal. </p> |
| <dl class="section return"><dt>Returns</dt><dd>Ordinal of the enum type. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ae7d268e2d84fdc34bdf1c7447a8980e0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae7d268e2d84fdc34bdf1c7447a8980e0">◆ </a></span>GetTypeId()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static int32_t <a class="el" href="structignite_1_1binary_1_1BinaryEnum.html">ignite::binary::BinaryEnum</a>< T * >::GetTypeId </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get binary object type ID. </p> |
| <dl class="section return"><dt>Returns</dt><dd>Type ID. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a09c0f434d55b5c8a7ce5c61d2a4ec939"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a09c0f434d55b5c8a7ce5c61d2a4ec939">◆ </a></span>GetTypeName()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static void <a class="el" href="structignite_1_1binary_1_1BinaryEnum.html">ignite::binary::BinaryEnum</a>< T * >::GetTypeName </td> |
| <td>(</td> |
| <td class="paramtype">std::string & </td> |
| <td class="paramname"><em>dst</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get binary object type name. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">dst</td><td>Output type name. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a5b59c3242d574bb1024f878858f47ac4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5b59c3242d574bb1024f878858f47ac4">◆ </a></span>IsNull()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static bool <a class="el" href="structignite_1_1binary_1_1BinaryEnum.html">ignite::binary::BinaryEnum</a>< T * >::IsNull </td> |
| <td>(</td> |
| <td class="paramtype">T *const & </td> |
| <td class="paramname"><em>obj</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Check whether passed enum should be interpreted as NULL. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">obj</td><td>Enum value to test. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>True if enum value should be interpreted as NULL. </dd></dl> |
| |
| </div> |
| </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 Mon Jan 10 2022 11:02:04 for Apache Ignite C++ by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.17 |
| </small></address> |
| </body> |
| </html> |
