| <!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> |
| <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> Apache Ignite C++: ignite::cache::query::QueryCursor< K, V > 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"> 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_1cache.html">cache</a></li><li class="navelem"><a class="el" href="namespaceignite_1_1cache_1_1query.html">query</a></li><li class="navelem"><a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html">QueryCursor</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classignite_1_1cache_1_1query_1_1QueryCursor-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">ignite::cache::query::QueryCursor< K, V > Class Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Query cursor class template. |
| <a href="classignite_1_1cache_1_1query_1_1QueryCursor.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="query__cursor_8h_source.html">query_cursor.h</a>></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:a23f71bdcccc38d2d9f6eeeaa4d635714"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html#a23f71bdcccc38d2d9f6eeeaa4d635714">QueryCursor</a> ()</td></tr> |
| <tr class="memdesc:a23f71bdcccc38d2d9f6eeeaa4d635714"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a23f71bdcccc38d2d9f6eeeaa4d635714">More...</a><br /></td></tr> |
| <tr class="separator:a23f71bdcccc38d2d9f6eeeaa4d635714"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a877e4922adbdfb8fb3d20bcec351ea35"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html#a877e4922adbdfb8fb3d20bcec351ea35">QueryCursor</a> (impl::cache::query::QueryCursorImpl *impl)</td></tr> |
| <tr class="memdesc:a877e4922adbdfb8fb3d20bcec351ea35"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a877e4922adbdfb8fb3d20bcec351ea35">More...</a><br /></td></tr> |
| <tr class="separator:a877e4922adbdfb8fb3d20bcec351ea35"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a901f70ae82074313f724edf959b1e515"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html#a901f70ae82074313f724edf959b1e515">HasNext</a> ()</td></tr> |
| <tr class="memdesc:a901f70ae82074313f724edf959b1e515"><td class="mdescLeft"> </td><td class="mdescRight">Check whether next entry exists. <a href="#a901f70ae82074313f724edf959b1e515">More...</a><br /></td></tr> |
| <tr class="separator:a901f70ae82074313f724edf959b1e515"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af7a18c4192ee1d87fc2bbf9f09182963"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html#af7a18c4192ee1d87fc2bbf9f09182963">HasNext</a> (<a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> &err)</td></tr> |
| <tr class="memdesc:af7a18c4192ee1d87fc2bbf9f09182963"><td class="mdescLeft"> </td><td class="mdescRight">Check whether next entry exists. <a href="#af7a18c4192ee1d87fc2bbf9f09182963">More...</a><br /></td></tr> |
| <tr class="separator:af7a18c4192ee1d87fc2bbf9f09182963"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab4e4f4e30437d379551aa8c652a99adf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1cache_1_1CacheEntry.html">CacheEntry</a>< K, V > </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html#ab4e4f4e30437d379551aa8c652a99adf">GetNext</a> ()</td></tr> |
| <tr class="memdesc:ab4e4f4e30437d379551aa8c652a99adf"><td class="mdescLeft"> </td><td class="mdescRight">Get next entry. <a href="#ab4e4f4e30437d379551aa8c652a99adf">More...</a><br /></td></tr> |
| <tr class="separator:ab4e4f4e30437d379551aa8c652a99adf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aac93dee2ff95426ac8e5573685181589"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1cache_1_1CacheEntry.html">CacheEntry</a>< K, V > </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html#aac93dee2ff95426ac8e5573685181589">GetNext</a> (<a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> &err)</td></tr> |
| <tr class="memdesc:aac93dee2ff95426ac8e5573685181589"><td class="mdescLeft"> </td><td class="mdescRight">Get next entry. <a href="#aac93dee2ff95426ac8e5573685181589">More...</a><br /></td></tr> |
| <tr class="separator:aac93dee2ff95426ac8e5573685181589"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae9ddd4b5f19be9c465cac942244187ca"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html#ae9ddd4b5f19be9c465cac942244187ca">GetAll</a> (std::vector< <a class="el" href="classignite_1_1cache_1_1CacheEntry.html">CacheEntry</a>< K, V > > &res)</td></tr> |
| <tr class="memdesc:ae9ddd4b5f19be9c465cac942244187ca"><td class="mdescLeft"> </td><td class="mdescRight">Get all entries. <a href="#ae9ddd4b5f19be9c465cac942244187ca">More...</a><br /></td></tr> |
| <tr class="separator:ae9ddd4b5f19be9c465cac942244187ca"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adffa4b2a7034b8ea5307487bf91104b9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html#adffa4b2a7034b8ea5307487bf91104b9">GetAll</a> (std::vector< <a class="el" href="classignite_1_1cache_1_1CacheEntry.html">CacheEntry</a>< K, V > > &res, <a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> &err)</td></tr> |
| <tr class="memdesc:adffa4b2a7034b8ea5307487bf91104b9"><td class="mdescLeft"> </td><td class="mdescRight">Get all entries. <a href="#adffa4b2a7034b8ea5307487bf91104b9">More...</a><br /></td></tr> |
| <tr class="separator:adffa4b2a7034b8ea5307487bf91104b9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a094549bf6b153a23315fe82099ff2596"><td class="memTemplParams" colspan="2">template<typename OutIter > </td></tr> |
| <tr class="memitem:a094549bf6b153a23315fe82099ff2596"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html#a094549bf6b153a23315fe82099ff2596">GetAll</a> (OutIter iter)</td></tr> |
| <tr class="memdesc:a094549bf6b153a23315fe82099ff2596"><td class="mdescLeft"> </td><td class="mdescRight">Get all entries. <a href="#a094549bf6b153a23315fe82099ff2596">More...</a><br /></td></tr> |
| <tr class="separator:a094549bf6b153a23315fe82099ff2596"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:addab3ffd899c62ef04392db7de01a7a4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html#addab3ffd899c62ef04392db7de01a7a4">IsValid</a> () const</td></tr> |
| <tr class="memdesc:addab3ffd899c62ef04392db7de01a7a4"><td class="mdescLeft"> </td><td class="mdescRight">Check if the instance is valid. <a href="#addab3ffd899c62ef04392db7de01a7a4">More...</a><br /></td></tr> |
| <tr class="separator:addab3ffd899c62ef04392db7de01a7a4"><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 K, typename V><br /> |
| class ignite::cache::query::QueryCursor< K, V ></h3> |
| |
| <p>Query cursor class template. </p> |
| <p>Both key and value types should be default-constructable, copy-constructable and assignable. Also BinaryType class template should be specialized for both types.</p> |
| <p>This class is implemented as a reference to an implementation so copying of this class instance will only create another reference to the same underlying object. Underlying object will be released automatically once all the instances are destructed. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a23f71bdcccc38d2d9f6eeeaa4d635714"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a23f71bdcccc38d2d9f6eeeaa4d635714">◆ </a></span>QueryCursor() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename K, typename V> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html">ignite::cache::query::QueryCursor</a>< K, V >::<a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html">QueryCursor</a> </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>Default constructor. </p> |
| <p>Constructed instance is not valid and thus can not be used as a cursor. </p> |
| |
| </div> |
| </div> |
| <a id="a877e4922adbdfb8fb3d20bcec351ea35"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a877e4922adbdfb8fb3d20bcec351ea35">◆ </a></span>QueryCursor() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename K, typename V> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html">ignite::cache::query::QueryCursor</a>< K, V >::<a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html">QueryCursor</a> </td> |
| <td>(</td> |
| <td class="paramtype">impl::cache::query::QueryCursorImpl * </td> |
| <td class="paramname"><em>impl</em></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 method. Should not be used by user.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">impl</td><td>Implementation. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ae9ddd4b5f19be9c465cac942244187ca"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae9ddd4b5f19be9c465cac942244187ca">◆ </a></span>GetAll() <span class="overload">[1/3]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename K, typename V> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html">ignite::cache::query::QueryCursor</a>< K, V >::GetAll </td> |
| <td>(</td> |
| <td class="paramtype">std::vector< <a class="el" href="classignite_1_1cache_1_1CacheEntry.html">CacheEntry</a>< K, V > > & </td> |
| <td class="paramname"><em>res</em></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 all entries. </p> |
| <p>This method should only be used on the valid instance.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">res</td><td>Vector where query entries will be stored.</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>class instance in case of failure. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="adffa4b2a7034b8ea5307487bf91104b9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adffa4b2a7034b8ea5307487bf91104b9">◆ </a></span>GetAll() <span class="overload">[2/3]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename K, typename V> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html">ignite::cache::query::QueryCursor</a>< K, V >::GetAll </td> |
| <td>(</td> |
| <td class="paramtype">std::vector< <a class="el" href="classignite_1_1cache_1_1CacheEntry.html">CacheEntry</a>< K, V > > & </td> |
| <td class="paramname"><em>res</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> & </td> |
| <td class="paramname"><em>err</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> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get all entries. </p> |
| <p>Properly sets error param in case of failure.</p> |
| <p>This method should only be used on the valid instance.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">res</td><td>Vector where query entries will be stored. </td></tr> |
| <tr><td class="paramname">err</td><td>Used to set operation result. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a094549bf6b153a23315fe82099ff2596"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a094549bf6b153a23315fe82099ff2596">◆ </a></span>GetAll() <span class="overload">[3/3]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename K, typename V> </div> |
| <div class="memtemplate"> |
| template<typename OutIter > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html">ignite::cache::query::QueryCursor</a>< K, V >::GetAll </td> |
| <td>(</td> |
| <td class="paramtype">OutIter </td> |
| <td class="paramname"><em>iter</em></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 all entries. </p> |
| <p>This method should only be used on the valid instance.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">iter</td><td>Output iterator. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ab4e4f4e30437d379551aa8c652a99adf"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab4e4f4e30437d379551aa8c652a99adf">◆ </a></span>GetNext() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename K, typename V> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classignite_1_1cache_1_1CacheEntry.html">CacheEntry</a><K, V> <a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html">ignite::cache::query::QueryCursor</a>< K, V >::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>Get next entry. </p> |
| <p>This method should only be used on the valid instance.</p> |
| <dl class="section return"><dt>Returns</dt><dd>Next entry.</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>class instance in case of failure. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="aac93dee2ff95426ac8e5573685181589"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aac93dee2ff95426ac8e5573685181589">◆ </a></span>GetNext() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename K, typename V> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classignite_1_1cache_1_1CacheEntry.html">CacheEntry</a><K, V> <a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html">ignite::cache::query::QueryCursor</a>< K, V >::GetNext </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> & </td> |
| <td class="paramname"><em>err</em></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 next entry. </p> |
| <p>Properly sets error param in case of failure.</p> |
| <p>This method should only be used on the valid instance.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">err</td><td>Used to set operation result. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Next entry on success and default-constructed entry on failure. Default-constructed entry contains default-constructed instances of both key and value types. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a901f70ae82074313f724edf959b1e515"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a901f70ae82074313f724edf959b1e515">◆ </a></span>HasNext() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename K, typename V> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool <a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html">ignite::cache::query::QueryCursor</a>< K, V >::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 entry exists. </p> |
| <p>This method should only be used on the valid instance.</p> |
| <dl class="section return"><dt>Returns</dt><dd>True if next entry exists.</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>class instance in case of failure. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="af7a18c4192ee1d87fc2bbf9f09182963"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af7a18c4192ee1d87fc2bbf9f09182963">◆ </a></span>HasNext() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename K, typename V> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool <a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html">ignite::cache::query::QueryCursor</a>< K, V >::HasNext </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> & </td> |
| <td class="paramname"><em>err</em></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 entry exists. </p> |
| <p>Properly sets error param in case of failure.</p> |
| <p>This method should only be used on the valid instance.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">err</td><td>Used to set operation result. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>True if next entry exists and operation resulted in success. Returns false on failure. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="addab3ffd899c62ef04392db7de01a7a4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#addab3ffd899c62ef04392db7de01a7a4">◆ </a></span>IsValid()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename K, typename V> </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool <a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html">ignite::cache::query::QueryCursor</a>< K, V >::IsValid </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</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 if the instance is valid. </p> |
| <p>Invalid instance can be returned if some of the previous operations have resulted in a failure. For example invalid instance can be returned by not-throwing version of method in case of error. Invalid instances also often can be created using default constructor.</p> |
| <dl class="section return"><dt>Returns</dt><dd>True if the instance is valid and can be used. </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li><a class="el" href="query__cursor_8h_source.html">query_cursor.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Mon Dec 20 2021 14:08:59 for Apache Ignite C++ by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |
