blob: 232200b7c0dabdac7ea6acb6df83cd24c8630bcb [file] [log] [blame]
<!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>&nbsp; Apache Ignite C++: ignite::binary::BinaryCollectionReader&lt; T &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>
<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.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&amp;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="classignite_1_1binary_1_1BinaryCollectionReader.html">BinaryCollectionReader</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_1BinaryCollectionReader-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ignite::binary::BinaryCollectionReader&lt; T &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Binary collection reader.
<a href="classignite_1_1binary_1_1BinaryCollectionReader.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:a3b88325f92a5a1784555a51db7648981"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryCollectionReader.html#a3b88325f92a5a1784555a51db7648981">BinaryCollectionReader</a> (impl::binary::BinaryReaderImpl *impl, int32_t id, const <a class="el" href="structignite_1_1binary_1_1CollectionType.html#a03610e138c65428dc81c08f62b7729bb">CollectionType::Type</a> type, int32_t size)</td></tr>
<tr class="memdesc:a3b88325f92a5a1784555a51db7648981"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="classignite_1_1binary_1_1BinaryCollectionReader.html#a3b88325f92a5a1784555a51db7648981">More...</a><br /></td></tr>
<tr class="separator:a3b88325f92a5a1784555a51db7648981"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a63f1059659d11bcfa211acce8fbf2c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryCollectionReader.html#a4a63f1059659d11bcfa211acce8fbf2c">HasNext</a> ()</td></tr>
<tr class="memdesc:a4a63f1059659d11bcfa211acce8fbf2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether next element is available for read. <a href="classignite_1_1binary_1_1BinaryCollectionReader.html#a4a63f1059659d11bcfa211acce8fbf2c">More...</a><br /></td></tr>
<tr class="separator:a4a63f1059659d11bcfa211acce8fbf2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a934ac1c5a28bee74c02a360abb736b19"><td class="memItemLeft" align="right" valign="top">T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryCollectionReader.html#a934ac1c5a28bee74c02a360abb736b19">GetNext</a> ()</td></tr>
<tr class="memdesc:a934ac1c5a28bee74c02a360abb736b19"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read next element. <a href="classignite_1_1binary_1_1BinaryCollectionReader.html#a934ac1c5a28bee74c02a360abb736b19">More...</a><br /></td></tr>
<tr class="separator:a934ac1c5a28bee74c02a360abb736b19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27353807d6da15623f8539c5f982bbd5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structignite_1_1binary_1_1CollectionType.html#a03610e138c65428dc81c08f62b7729bb">CollectionType::Type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryCollectionReader.html#a27353807d6da15623f8539c5f982bbd5">GetType</a> ()</td></tr>
<tr class="memdesc:a27353807d6da15623f8539c5f982bbd5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get collection type. <a href="classignite_1_1binary_1_1BinaryCollectionReader.html#a27353807d6da15623f8539c5f982bbd5">More...</a><br /></td></tr>
<tr class="separator:a27353807d6da15623f8539c5f982bbd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a629e12f4aa308243c57fe4a4563d84b1"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryCollectionReader.html#a629e12f4aa308243c57fe4a4563d84b1">GetSize</a> ()</td></tr>
<tr class="memdesc:a629e12f4aa308243c57fe4a4563d84b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get collection size. <a href="classignite_1_1binary_1_1BinaryCollectionReader.html#a629e12f4aa308243c57fe4a4563d84b1">More...</a><br /></td></tr>
<tr class="separator:a629e12f4aa308243c57fe4a4563d84b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7030978b9711e8f5dab63028558867e2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1binary_1_1BinaryCollectionReader.html#a7030978b9711e8f5dab63028558867e2">IsNull</a> ()</td></tr>
<tr class="memdesc:a7030978b9711e8f5dab63028558867e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether collection is NULL. <a href="classignite_1_1binary_1_1BinaryCollectionReader.html#a7030978b9711e8f5dab63028558867e2">More...</a><br /></td></tr>
<tr class="separator:a7030978b9711e8f5dab63028558867e2"><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 />
class ignite::binary::BinaryCollectionReader&lt; T &gt;</h3>
<p>Binary collection reader. </p>
<p>Can be used to read collection of values of the specific type one by one.</p>
<p>Use <a class="el" href="classignite_1_1binary_1_1BinaryCollectionReader.html#a934ac1c5a28bee74c02a360abb736b19" title="Read next element.">GetNext()</a> method to read array value by value while <a class="el" href="classignite_1_1binary_1_1BinaryCollectionReader.html#a4a63f1059659d11bcfa211acce8fbf2c" 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 id="a3b88325f92a5a1784555a51db7648981"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b88325f92a5a1784555a51db7648981">&#9670;&nbsp;</a></span>BinaryCollectionReader()</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"><a class="el" href="classignite_1_1binary_1_1BinaryCollectionReader.html">ignite::binary::BinaryCollectionReader</a>&lt; T &gt;::<a class="el" href="classignite_1_1binary_1_1BinaryCollectionReader.html">BinaryCollectionReader</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">const <a class="el" href="structignite_1_1binary_1_1CollectionType.html#a03610e138c65428dc81c08f62b7729bb">CollectionType::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>Collection type. </td></tr>
<tr><td class="paramname">size</td><td>Collection size. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a934ac1c5a28bee74c02a360abb736b19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a934ac1c5a28bee74c02a360abb736b19">&#9670;&nbsp;</a></span>GetNext()</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">T <a class="el" href="classignite_1_1binary_1_1BinaryCollectionReader.html">ignite::binary::BinaryCollectionReader</a>&lt; T &gt;::GetNext </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>Read next element. </p>
<dl class="section return"><dt>Returns</dt><dd>Next element.</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 id="a629e12f4aa308243c57fe4a4563d84b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a629e12f4aa308243c57fe4a4563d84b1">&#9670;&nbsp;</a></span>GetSize()</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">int32_t <a class="el" href="classignite_1_1binary_1_1BinaryCollectionReader.html">ignite::binary::BinaryCollectionReader</a>&lt; T &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 collection size. </p>
<dl class="section return"><dt>Returns</dt><dd>Size or -1 if collection is NULL. </dd></dl>
</div>
</div>
<a id="a27353807d6da15623f8539c5f982bbd5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27353807d6da15623f8539c5f982bbd5">&#9670;&nbsp;</a></span>GetType()</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"><a class="el" href="structignite_1_1binary_1_1CollectionType.html#a03610e138c65428dc81c08f62b7729bb">CollectionType::Type</a> <a class="el" href="classignite_1_1binary_1_1BinaryCollectionReader.html">ignite::binary::BinaryCollectionReader</a>&lt; T &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 collection type. </p>
<dl class="section return"><dt>Returns</dt><dd>Collection type. See <a class="el" href="structignite_1_1binary_1_1CollectionType.html" title="Binary collection types.">CollectionType</a> for the list of available values and their description. </dd></dl>
</div>
</div>
<a id="a4a63f1059659d11bcfa211acce8fbf2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a63f1059659d11bcfa211acce8fbf2c">&#9670;&nbsp;</a></span>HasNext()</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">bool <a class="el" href="classignite_1_1binary_1_1BinaryCollectionReader.html">ignite::binary::BinaryCollectionReader</a>&lt; T &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 id="a7030978b9711e8f5dab63028558867e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7030978b9711e8f5dab63028558867e2">&#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">bool <a class="el" href="classignite_1_1binary_1_1BinaryCollectionReader.html">ignite::binary::BinaryCollectionReader</a>&lt; T &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 collection is NULL. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the collection 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 Mon Jan 10 2022 11:02:04 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.17
</small></address>
</body>
</html>