| <!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::BinaryType< 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_1BinaryType_3_01T_01_5_01_4.html">BinaryType< 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_1BinaryType_3_01T_01_5_01_4-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">ignite::binary::BinaryType< T * > Struct Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a class="el" href="structignite_1_1binary_1_1BinaryType.html" title="Binary type structure.">BinaryType</a> template specialization for pointers. |
| <a href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_01_4.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="binary__type_8h_source.html">binary_type.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:a050cc894615dd3813942ef2ea21f11fc"><td class="memItemLeft" align="right" valign="top"><a id="a050cc894615dd3813942ef2ea21f11fc"></a> |
| typedef <a class="el" href="structignite_1_1binary_1_1BinaryType.html">BinaryType</a>< T > </td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_01_4.html#a050cc894615dd3813942ef2ea21f11fc">BinaryTypeDereferenced</a></td></tr> |
| <tr class="memdesc:a050cc894615dd3813942ef2ea21f11fc"><td class="mdescLeft"> </td><td class="mdescRight">Actual type. <br /></td></tr> |
| <tr class="separator:a050cc894615dd3813942ef2ea21f11fc"><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:a73dff8aee56a39ca8abefba2ff6bdcb2"><td class="memItemLeft" align="right" valign="top">static int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_01_4.html#a73dff8aee56a39ca8abefba2ff6bdcb2">GetTypeId</a> ()</td></tr> |
| <tr class="memdesc:a73dff8aee56a39ca8abefba2ff6bdcb2"><td class="mdescLeft"> </td><td class="mdescRight">Get binary object type ID. <a href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_01_4.html#a73dff8aee56a39ca8abefba2ff6bdcb2">More...</a><br /></td></tr> |
| <tr class="separator:a73dff8aee56a39ca8abefba2ff6bdcb2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1ee2fabcdd0d7422bd52781401b6a5f5"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_01_4.html#a1ee2fabcdd0d7422bd52781401b6a5f5">GetTypeName</a> (std::string &dst)</td></tr> |
| <tr class="memdesc:a1ee2fabcdd0d7422bd52781401b6a5f5"><td class="mdescLeft"> </td><td class="mdescRight">Get binary object type name. <a href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_01_4.html#a1ee2fabcdd0d7422bd52781401b6a5f5">More...</a><br /></td></tr> |
| <tr class="separator:a1ee2fabcdd0d7422bd52781401b6a5f5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a150c5152f3d71fedcd52d4f2717e0c09"><td class="memItemLeft" align="right" valign="top">static int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_01_4.html#a150c5152f3d71fedcd52d4f2717e0c09">GetFieldId</a> (const char *name)</td></tr> |
| <tr class="memdesc:a150c5152f3d71fedcd52d4f2717e0c09"><td class="mdescLeft"> </td><td class="mdescRight">Get binary object field ID. <a href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_01_4.html#a150c5152f3d71fedcd52d4f2717e0c09">More...</a><br /></td></tr> |
| <tr class="separator:a150c5152f3d71fedcd52d4f2717e0c09"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a71b97ab4fc7349446f9cfac3ad7eb6f1"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_01_4.html#a71b97ab4fc7349446f9cfac3ad7eb6f1">Write</a> (<a class="el" href="classignite_1_1binary_1_1BinaryWriter.html">BinaryWriter</a> &writer, T *const &obj)</td></tr> |
| <tr class="memdesc:a71b97ab4fc7349446f9cfac3ad7eb6f1"><td class="mdescLeft"> </td><td class="mdescRight">Write binary object. <a href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_01_4.html#a71b97ab4fc7349446f9cfac3ad7eb6f1">More...</a><br /></td></tr> |
| <tr class="separator:a71b97ab4fc7349446f9cfac3ad7eb6f1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0b62281ae3b1ad8af8f4bf935381edb0"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_01_4.html#a0b62281ae3b1ad8af8f4bf935381edb0">Read</a> (<a class="el" href="classignite_1_1binary_1_1BinaryReader.html">BinaryReader</a> &reader, T *&dst)</td></tr> |
| <tr class="memdesc:a0b62281ae3b1ad8af8f4bf935381edb0"><td class="mdescLeft"> </td><td class="mdescRight">Read binary object. <a href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_01_4.html#a0b62281ae3b1ad8af8f4bf935381edb0">More...</a><br /></td></tr> |
| <tr class="separator:a0b62281ae3b1ad8af8f4bf935381edb0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5efa432412c12e6ec8f92e55c602f889"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_01_4.html#a5efa432412c12e6ec8f92e55c602f889">IsNull</a> (T *const &obj)</td></tr> |
| <tr class="memdesc:a5efa432412c12e6ec8f92e55c602f889"><td class="mdescLeft"> </td><td class="mdescRight">Check whether passed binary object should be interpreted as NULL. <a href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_01_4.html#a5efa432412c12e6ec8f92e55c602f889">More...</a><br /></td></tr> |
| <tr class="separator:a5efa432412c12e6ec8f92e55c602f889"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7deeb22e27422d19c071a40cec016aed"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_01_4.html#a7deeb22e27422d19c071a40cec016aed">GetNull</a> (T *&dst)</td></tr> |
| <tr class="memdesc:a7deeb22e27422d19c071a40cec016aed"><td class="mdescLeft"> </td><td class="mdescRight">Get NULL value for the given binary type. <a href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_01_4.html#a7deeb22e27422d19c071a40cec016aed">More...</a><br /></td></tr> |
| <tr class="separator:a7deeb22e27422d19c071a40cec016aed"><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::BinaryType< T * ></h3> |
| |
| <p><a class="el" href="structignite_1_1binary_1_1BinaryType.html" title="Binary type structure.">BinaryType</a> template specialization for pointers. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a150c5152f3d71fedcd52d4f2717e0c09"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a150c5152f3d71fedcd52d4f2717e0c09">◆ </a></span>GetFieldId()</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_1BinaryType.html">ignite::binary::BinaryType</a>< T * >::GetFieldId </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>name</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 field ID. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>Field name. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Field ID. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a7deeb22e27422d19c071a40cec016aed"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7deeb22e27422d19c071a40cec016aed">◆ </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_1BinaryType.html">ignite::binary::BinaryType</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 given binary type. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">dst</td><td>NULL value for the type. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a73dff8aee56a39ca8abefba2ff6bdcb2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a73dff8aee56a39ca8abefba2ff6bdcb2">◆ </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_1BinaryType.html">ignite::binary::BinaryType</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="a1ee2fabcdd0d7422bd52781401b6a5f5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1ee2fabcdd0d7422bd52781401b6a5f5">◆ </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_1BinaryType.html">ignite::binary::BinaryType</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="a5efa432412c12e6ec8f92e55c602f889"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5efa432412c12e6ec8f92e55c602f889">◆ </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_1BinaryType.html">ignite::binary::BinaryType</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 binary object should be interpreted as NULL. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">obj</td><td>Binary object to test. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>True if binary object should be interpreted as NULL. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a0b62281ae3b1ad8af8f4bf935381edb0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0b62281ae3b1ad8af8f4bf935381edb0">◆ </a></span>Read()</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_1BinaryType.html">ignite::binary::BinaryType</a>< T * >::Read </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classignite_1_1binary_1_1BinaryReader.html">BinaryReader</a> & </td> |
| <td class="paramname"><em>reader</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">T *& </td> |
| <td class="paramname"><em>dst</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 class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Read binary object. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">reader</td><td>Reader. </td></tr> |
| <tr><td class="paramname">dst</td><td>Output object. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a71b97ab4fc7349446f9cfac3ad7eb6f1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a71b97ab4fc7349446f9cfac3ad7eb6f1">◆ </a></span>Write()</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_1BinaryType.html">ignite::binary::BinaryType</a>< T * >::Write </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classignite_1_1binary_1_1BinaryWriter.html">BinaryWriter</a> & </td> |
| <td class="paramname"><em>writer</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">T *const & </td> |
| <td class="paramname"><em>obj</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 class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Write binary object. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">writer</td><td>Writer. </td></tr> |
| <tr><td class="paramname">obj</td><td>Object. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this struct was generated from the following file:<ul> |
| <li><a class="el" href="binary__type_8h_source.html">binary_type.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> |
