blob: cde5f795362552c88e7b80a6ae3d6befd0b28eec [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>
<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::thin::cache::query::QueryFieldsCursor Class 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.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_1thin.html">thin</a></li><li class="navelem"><a class="el" href="namespaceignite_1_1thin_1_1cache.html">cache</a></li><li class="navelem"><b>query</b></li><li class="navelem"><a class="el" href="classignite_1_1thin_1_1cache_1_1query_1_1QueryFieldsCursor.html">QueryFieldsCursor</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_1thin_1_1cache_1_1query_1_1QueryFieldsCursor-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ignite::thin::cache::query::QueryFieldsCursor Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Query fields cursor.
<a href="classignite_1_1thin_1_1cache_1_1query_1_1QueryFieldsCursor.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="thin-client_2include_2ignite_2thin_2cache_2query_2query__fields__cursor_8h_source.html">query_fields_cursor.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:a8029abebf15fb0f1174886e3fe9c025d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1cache_1_1query_1_1QueryFieldsCursor.html#a8029abebf15fb0f1174886e3fe9c025d">QueryFieldsCursor</a> (const common::concurrent::SharedPointer&lt; void &gt; &amp;impl)</td></tr>
<tr class="memdesc:a8029abebf15fb0f1174886e3fe9c025d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a8029abebf15fb0f1174886e3fe9c025d">More...</a><br /></td></tr>
<tr class="separator:a8029abebf15fb0f1174886e3fe9c025d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4dba63f15cfd6cf980a4b576af13f080"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1cache_1_1query_1_1QueryFieldsCursor.html#a4dba63f15cfd6cf980a4b576af13f080">HasNext</a> ()</td></tr>
<tr class="memdesc:a4dba63f15cfd6cf980a4b576af13f080"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether next entry exists. <a href="#a4dba63f15cfd6cf980a4b576af13f080">More...</a><br /></td></tr>
<tr class="separator:a4dba63f15cfd6cf980a4b576af13f080"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01f71eb22a28d4ad4b59e672f3cffd5a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1thin_1_1cache_1_1query_1_1QueryFieldsRow.html">QueryFieldsRow</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1cache_1_1query_1_1QueryFieldsCursor.html#a01f71eb22a28d4ad4b59e672f3cffd5a">GetNext</a> ()</td></tr>
<tr class="memdesc:a01f71eb22a28d4ad4b59e672f3cffd5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get next entry. <a href="#a01f71eb22a28d4ad4b59e672f3cffd5a">More...</a><br /></td></tr>
<tr class="separator:a01f71eb22a28d4ad4b59e672f3cffd5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04fc49e53d89320ef71fd31104dc611c"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; std::string &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1cache_1_1query_1_1QueryFieldsCursor.html#a04fc49e53d89320ef71fd31104dc611c">GetColumnNames</a> () const</td></tr>
<tr class="memdesc:a04fc49e53d89320ef71fd31104dc611c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get column names. <a href="#a04fc49e53d89320ef71fd31104dc611c">More...</a><br /></td></tr>
<tr class="separator:a04fc49e53d89320ef71fd31104dc611c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Query fields cursor. </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 &amp; Destructor Documentation</h2>
<a id="a8029abebf15fb0f1174886e3fe9c025d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8029abebf15fb0f1174886e3fe9c025d">&#9670;&nbsp;</a></span>QueryFieldsCursor()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ignite::thin::cache::query::QueryFieldsCursor::QueryFieldsCursor </td>
<td>(</td>
<td class="paramtype">const common::concurrent::SharedPointer&lt; void &gt; &amp;&#160;</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">explicit</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="a04fc49e53d89320ef71fd31104dc611c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04fc49e53d89320ef71fd31104dc611c">&#9670;&nbsp;</a></span>GetColumnNames()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::vector&lt;std::string&gt;&amp; ignite::thin::cache::query::QueryFieldsCursor::GetColumnNames </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get column names. </p>
<dl class="section return"><dt>Returns</dt><dd>Column names. </dd></dl>
</div>
</div>
<a id="a01f71eb22a28d4ad4b59e672f3cffd5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01f71eb22a28d4ad4b59e672f3cffd5a">&#9670;&nbsp;</a></span>GetNext()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classignite_1_1thin_1_1cache_1_1query_1_1QueryFieldsRow.html">QueryFieldsRow</a> ignite::thin::cache::query::QueryFieldsCursor::GetNext </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get next entry. </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="a4dba63f15cfd6cf980a4b576af13f080"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4dba63f15cfd6cf980a4b576af13f080">&#9670;&nbsp;</a></span>HasNext()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ignite::thin::cache::query::QueryFieldsCursor::HasNext </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether next entry exists. </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>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="thin-client_2include_2ignite_2thin_2cache_2query_2query__fields__cursor_8h_source.html">thin-client/include/ignite/thin/cache/query/query_fields_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 &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>