blob: c62c2f8544c79586857baccb3cfe28c29134be4d [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>
<link rel="canonical" href="https://ignite.apache.org/releases/2.9.0/cppdoc/structignite_1_1binary_1_1BinaryType_3_01T_01_5_4.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>&nbsp; Apache Ignite C++: ignite::binary::BinaryType&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" />
<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">&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_1BinaryType_3_01T_01_5_4.html">BinaryType&lt; T *&gt;</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_4-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ignite::binary::BinaryType&lt; T *&gt; 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_4.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="binary__type_8h_source.html">binary_type.h</a>&gt;</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:a6af48dd63474d8baf2756192597e9c10"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structignite_1_1binary_1_1BinaryType.html">BinaryType</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_4.html#a6af48dd63474d8baf2756192597e9c10">BinaryTypeDereferenced</a></td></tr>
<tr class="memdesc:a6af48dd63474d8baf2756192597e9c10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Actual type. <a href="#a6af48dd63474d8baf2756192597e9c10">More...</a><br /></td></tr>
<tr class="separator:a6af48dd63474d8baf2756192597e9c10"><td class="memSeparator" colspan="2">&#160;</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:af06fde45e4c80bf09031f0be664a709a"><td class="memItemLeft" align="right" valign="top">static int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_4.html#af06fde45e4c80bf09031f0be664a709a">GetTypeId</a> ()</td></tr>
<tr class="memdesc:af06fde45e4c80bf09031f0be664a709a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get binary object type ID. <a href="#af06fde45e4c80bf09031f0be664a709a">More...</a><br /></td></tr>
<tr class="separator:af06fde45e4c80bf09031f0be664a709a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed708babe7fb5738ddf279b761d0bd81"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_4.html#aed708babe7fb5738ddf279b761d0bd81">GetTypeName</a> (std::string &amp;dst)</td></tr>
<tr class="memdesc:aed708babe7fb5738ddf279b761d0bd81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get binary object type name. <a href="#aed708babe7fb5738ddf279b761d0bd81">More...</a><br /></td></tr>
<tr class="separator:aed708babe7fb5738ddf279b761d0bd81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8be0fd758fe0bfcf7c0b71d9711f9a1"><td class="memItemLeft" align="right" valign="top">static int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_4.html#ad8be0fd758fe0bfcf7c0b71d9711f9a1">GetFieldId</a> (const char *name)</td></tr>
<tr class="memdesc:ad8be0fd758fe0bfcf7c0b71d9711f9a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get binary object field ID. <a href="#ad8be0fd758fe0bfcf7c0b71d9711f9a1">More...</a><br /></td></tr>
<tr class="separator:ad8be0fd758fe0bfcf7c0b71d9711f9a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2c59bccd13eab66011d394e438b5101"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_4.html#ad2c59bccd13eab66011d394e438b5101">Write</a> (<a class="el" href="classignite_1_1binary_1_1BinaryWriter.html">BinaryWriter</a> &amp;writer, T *const &amp;obj)</td></tr>
<tr class="memdesc:ad2c59bccd13eab66011d394e438b5101"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write binary object. <a href="#ad2c59bccd13eab66011d394e438b5101">More...</a><br /></td></tr>
<tr class="separator:ad2c59bccd13eab66011d394e438b5101"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17c61a2b4e2955f7578f88bbfe1045f9"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_4.html#a17c61a2b4e2955f7578f88bbfe1045f9">Read</a> (<a class="el" href="classignite_1_1binary_1_1BinaryReader.html">BinaryReader</a> &amp;reader, T *&amp;dst)</td></tr>
<tr class="memdesc:a17c61a2b4e2955f7578f88bbfe1045f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read binary object. <a href="#a17c61a2b4e2955f7578f88bbfe1045f9">More...</a><br /></td></tr>
<tr class="separator:a17c61a2b4e2955f7578f88bbfe1045f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf3622c741061c74d00fc20dbbcb2dfd"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_4.html#adf3622c741061c74d00fc20dbbcb2dfd">IsNull</a> (T *const &amp;obj)</td></tr>
<tr class="memdesc:adf3622c741061c74d00fc20dbbcb2dfd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether passed binary object should be interpreted as NULL. <a href="#adf3622c741061c74d00fc20dbbcb2dfd">More...</a><br /></td></tr>
<tr class="separator:adf3622c741061c74d00fc20dbbcb2dfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c29fef8e7ecbdb46c815b3cf4d97608"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_4.html#a7c29fef8e7ecbdb46c815b3cf4d97608">GetNull</a> (T *&amp;dst)</td></tr>
<tr class="memdesc:a7c29fef8e7ecbdb46c815b3cf4d97608"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get NULL value for the given binary type. <a href="#a7c29fef8e7ecbdb46c815b3cf4d97608">More...</a><br /></td></tr>
<tr class="separator:a7c29fef8e7ecbdb46c815b3cf4d97608"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<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::BinaryType&lt; T *&gt;</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 Typedef Documentation</h2>
<a id="a6af48dd63474d8baf2756192597e9c10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6af48dd63474d8baf2756192597e9c10">&#9670;&nbsp;</a></span>BinaryTypeDereferenced</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="structignite_1_1binary_1_1BinaryType.html">BinaryType</a>&lt;T&gt; <a class="el" href="structignite_1_1binary_1_1BinaryType.html">ignite::binary::BinaryType</a>&lt; T *&gt;::<a class="el" href="structignite_1_1binary_1_1BinaryType_3_01T_01_5_4.html#a6af48dd63474d8baf2756192597e9c10">BinaryTypeDereferenced</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Actual type. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad8be0fd758fe0bfcf7c0b71d9711f9a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8be0fd758fe0bfcf7c0b71d9711f9a1">&#9670;&nbsp;</a></span>GetFieldId()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </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>&lt; T *&gt;::GetFieldId </td>
<td>(</td>
<td class="paramtype">const char *&#160;</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="a7c29fef8e7ecbdb46c815b3cf4d97608"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c29fef8e7ecbdb46c815b3cf4d97608">&#9670;&nbsp;</a></span>GetNull()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </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>&lt; T *&gt;::GetNull </td>
<td>(</td>
<td class="paramtype">T *&amp;&#160;</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="af06fde45e4c80bf09031f0be664a709a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af06fde45e4c80bf09031f0be664a709a">&#9670;&nbsp;</a></span>GetTypeId()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </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>&lt; T *&gt;::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="aed708babe7fb5738ddf279b761d0bd81"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed708babe7fb5738ddf279b761d0bd81">&#9670;&nbsp;</a></span>GetTypeName()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </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>&lt; T *&gt;::GetTypeName </td>
<td>(</td>
<td class="paramtype">std::string &amp;&#160;</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="adf3622c741061c74d00fc20dbbcb2dfd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf3622c741061c74d00fc20dbbcb2dfd">&#9670;&nbsp;</a></span>IsNull()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </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>&lt; T *&gt;::IsNull </td>
<td>(</td>
<td class="paramtype">T *const &amp;&#160;</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="a17c61a2b4e2955f7578f88bbfe1045f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17c61a2b4e2955f7578f88bbfe1045f9">&#9670;&nbsp;</a></span>Read()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </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>&lt; T *&gt;::Read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classignite_1_1binary_1_1BinaryReader.html">BinaryReader</a> &amp;&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T *&amp;&#160;</td>
<td class="paramname"><em>dst</em>&#160;</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="ad2c59bccd13eab66011d394e438b5101"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2c59bccd13eab66011d394e438b5101">&#9670;&nbsp;</a></span>Write()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </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>&lt; T *&gt;::Write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classignite_1_1binary_1_1BinaryWriter.html">BinaryWriter</a> &amp;&#160;</td>
<td class="paramname"><em>writer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T *const &amp;&#160;</td>
<td class="paramname"><em>obj</em>&#160;</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 Thu Oct 15 2020 12:17:17 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>