blob: 885e50ad7a6018a0dd6889f2e79af5ab9ae4c6c5 [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.6.0/cppdoc/classignite_1_1binary_1_1BinaryMapReader.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.11"/>
<title>&nbsp; Apache Ignite C++: ignite::binary::BinaryMapReader&lt; K, V &gt; Class 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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</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_1BinaryMapReader.html">BinaryMapReader</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classignite_1_1binary_1_1BinaryMapReader-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ignite::binary::BinaryMapReader&lt; K, V &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Binary map reader.
<a href="classignite_1_1binary_1_1BinaryMapReader.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="binary__containers_8h_source.html">binary_containers.h</a>&gt;</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:a2b5fe1df5d800106befb2b6984b16f2d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryMapReader.html#a2b5fe1df5d800106befb2b6984b16f2d">BinaryMapReader</a> (impl::binary::BinaryReaderImpl *impl, int32_t id, <a class="el" href="structignite_1_1binary_1_1MapType.html#a138cf8f1db233f607ea34aaa8a99b456">MapType::Type</a> type, int32_t size)</td></tr>
<tr class="memdesc:a2b5fe1df5d800106befb2b6984b16f2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a2b5fe1df5d800106befb2b6984b16f2d">More...</a><br /></td></tr>
<tr class="separator:a2b5fe1df5d800106befb2b6984b16f2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad62c2bfd4e90e4c0080e22ed88f38fda"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryMapReader.html#ad62c2bfd4e90e4c0080e22ed88f38fda">HasNext</a> ()</td></tr>
<tr class="memdesc:ad62c2bfd4e90e4c0080e22ed88f38fda"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether next element is available for read. <a href="#ad62c2bfd4e90e4c0080e22ed88f38fda">More...</a><br /></td></tr>
<tr class="separator:ad62c2bfd4e90e4c0080e22ed88f38fda"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4cdf13a2658198ac1972afe90727dbf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryMapReader.html#ad4cdf13a2658198ac1972afe90727dbf">GetNext</a> (K &amp;key, V &amp;val)</td></tr>
<tr class="memdesc:ad4cdf13a2658198ac1972afe90727dbf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read next element. <a href="#ad4cdf13a2658198ac1972afe90727dbf">More...</a><br /></td></tr>
<tr class="separator:ad4cdf13a2658198ac1972afe90727dbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5910e720e45b814afd5679a2f53a1729"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structignite_1_1binary_1_1MapType.html#a138cf8f1db233f607ea34aaa8a99b456">MapType::Type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryMapReader.html#a5910e720e45b814afd5679a2f53a1729">GetType</a> ()</td></tr>
<tr class="memdesc:a5910e720e45b814afd5679a2f53a1729"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get map type. <a href="#a5910e720e45b814afd5679a2f53a1729">More...</a><br /></td></tr>
<tr class="separator:a5910e720e45b814afd5679a2f53a1729"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69edda88dcef3c1459591f725d0e1c3e"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryMapReader.html#a69edda88dcef3c1459591f725d0e1c3e">GetSize</a> ()</td></tr>
<tr class="memdesc:a69edda88dcef3c1459591f725d0e1c3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get map size. <a href="#a69edda88dcef3c1459591f725d0e1c3e">More...</a><br /></td></tr>
<tr class="separator:a69edda88dcef3c1459591f725d0e1c3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74ac58c53a8bc524199fcc6fe479e7ef"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryMapReader.html#a74ac58c53a8bc524199fcc6fe479e7ef">IsNull</a> ()</td></tr>
<tr class="memdesc:a74ac58c53a8bc524199fcc6fe479e7ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether map is NULL. <a href="#a74ac58c53a8bc524199fcc6fe479e7ef">More...</a><br /></td></tr>
<tr class="separator:a74ac58c53a8bc524199fcc6fe479e7ef"><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 K, typename V&gt;<br />
class ignite::binary::BinaryMapReader&lt; K, V &gt;</h3>
<p>Binary map reader. </p>
<p>Can be used to read map entry by entry.</p>
<p>Use <a class="el" href="classignite_1_1binary_1_1BinaryMapReader.html#ad4cdf13a2658198ac1972afe90727dbf" title="Read next element. ">GetNext()</a> method to read array value by value while <a class="el" href="classignite_1_1binary_1_1BinaryMapReader.html#ad62c2bfd4e90e4c0080e22ed88f38fda" title="Check whether next element is available for read. ">HasNext()</a> method returns true. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a2b5fe1df5d800106befb2b6984b16f2d"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename K, typename V&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classignite_1_1binary_1_1BinaryMapReader.html">ignite::binary::BinaryMapReader</a>&lt; K, V &gt;::<a class="el" href="classignite_1_1binary_1_1BinaryMapReader.html">BinaryMapReader</a> </td>
<td>(</td>
<td class="paramtype">impl::binary::BinaryReaderImpl *&#160;</td>
<td class="paramname"><em>impl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structignite_1_1binary_1_1MapType.html#a138cf8f1db233f607ea34aaa8a99b456">MapType::Type</a>&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>size</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<p>Internal call. Should not be used by user.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">impl</td><td>Reader implementation. </td></tr>
<tr><td class="paramname">id</td><td>Identifier. </td></tr>
<tr><td class="paramname">type</td><td>Map type. </td></tr>
<tr><td class="paramname">size</td><td>Map size. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ad4cdf13a2658198ac1972afe90727dbf"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename K, typename V&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classignite_1_1binary_1_1BinaryMapReader.html">ignite::binary::BinaryMapReader</a>&lt; K, V &gt;::GetNext </td>
<td>(</td>
<td class="paramtype">K &amp;&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">V &amp;&#160;</td>
<td class="paramname"><em>val</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Read next element. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>Pointer to buffer where key element should be stored. Should not be null. </td></tr>
<tr><td class="paramname">val</td><td>Pointer to buffer where value element should be stored. Should not be null.</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classignite_1_1IgniteError.html" title="Ignite error information. ">IgniteError</a></td><td>if there is no element to read. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a69edda88dcef3c1459591f725d0e1c3e"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename K, typename V&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int32_t <a class="el" href="classignite_1_1binary_1_1BinaryMapReader.html">ignite::binary::BinaryMapReader</a>&lt; K, V &gt;::GetSize </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get map size. </p>
<dl class="section return"><dt>Returns</dt><dd>Size or -1 if map is NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="a5910e720e45b814afd5679a2f53a1729"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename K, typename V&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structignite_1_1binary_1_1MapType.html#a138cf8f1db233f607ea34aaa8a99b456">MapType::Type</a> <a class="el" href="classignite_1_1binary_1_1BinaryMapReader.html">ignite::binary::BinaryMapReader</a>&lt; K, V &gt;::GetType </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get map type. </p>
<dl class="section return"><dt>Returns</dt><dd>Map type. See <a class="el" href="structignite_1_1binary_1_1MapType.html" title="Binary map types. ">MapType</a> for the list of available values and their description. </dd></dl>
</div>
</div>
<a class="anchor" id="ad62c2bfd4e90e4c0080e22ed88f38fda"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename K, typename V&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classignite_1_1binary_1_1BinaryMapReader.html">ignite::binary::BinaryMapReader</a>&lt; K, V &gt;::HasNext </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether next element is available for read. </p>
<dl class="section return"><dt>Returns</dt><dd>True if available. </dd></dl>
</div>
</div>
<a class="anchor" id="a74ac58c53a8bc524199fcc6fe479e7ef"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename K, typename V&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classignite_1_1binary_1_1BinaryMapReader.html">ignite::binary::BinaryMapReader</a>&lt; K, V &gt;::IsNull </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether map is NULL. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the map is NULL. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="binary__containers_8h_source.html">binary_containers.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jul 10 2018 10:57:32 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.11
</small></address>
</body>
</html>