Google Git
Sign in
apache / geode-site / c1e1f5ba34f0a4e0af949688890f67e7e7b3f8f7 / . / releases / latest / cppdocs / a00847.html
blob: e946827472c5112689e5c38473c5fcd89a60f6aa [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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Apache Geode Native C++ Reference: apache::geode::client::ResultSet 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Apache Geode Native C++ Reference
&#160;<span id="projectnumber">1.13.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('a00847.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">apache::geode::client::ResultSet Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>A <a class="el" href="a00847.html" title="A ResultSet may be obtained after executing a Query which is obtained from a QueryService which in tu...">ResultSet</a> may be obtained after executing a <a class="el" href="a00807.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">Query</a> which is obtained from a <a class="el" href="a00811.html" title="QueryService is the class obtained from a Cache.">QueryService</a> which in turn is obtained from a <a class="el" href="a00287.html" title="Caches are obtained from the create method on the CacheFactory#create class.">Cache</a>.
<a href="a00847.html#details">More...</a></p>
<p>Inherits <a class="el" href="a00851.html">apache::geode::client::SelectResults</a>.</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:a51a183166096893fcb16b569327c60b3"><td class="memItemLeft" align="right" valign="top">typedef std::vector&lt; std::shared_ptr&lt; <a class="el" href="a00855.html">Cacheable</a> &gt; &gt;::<a class="el" href="a00851.html#a51a183166096893fcb16b569327c60b3">iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00851.html#a51a183166096893fcb16b569327c60b3">iterator</a></td></tr>
<tr class="memdesc:a51a183166096893fcb16b569327c60b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface of an iterator for <code><a class="el" href="a00851.html" title="A SelectResults is obtained by executing a Query on the server.">SelectResults</a></code>. <a href="#a51a183166096893fcb16b569327c60b3">More...</a><br /></td></tr>
<tr class="separator:a51a183166096893fcb16b569327c60b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a47897882766667431cdf1eebc1eb00b3"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00851.html#a51a183166096893fcb16b569327c60b3">iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00851.html#a47897882766667431cdf1eebc1eb00b3">begin</a> ()=0</td></tr>
<tr class="memdesc:a47897882766667431cdf1eebc1eb00b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get an iterator pointing to the start of <code><a class="el" href="a00851.html" title="A SelectResults is obtained by executing a Query on the server.">SelectResults</a></code>. <a href="#a47897882766667431cdf1eebc1eb00b3">More...</a><br /></td></tr>
<tr class="separator:a47897882766667431cdf1eebc1eb00b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a626bd746b3e1919281221eb9a5f1d105"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00851.html#a51a183166096893fcb16b569327c60b3">iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00851.html#a626bd746b3e1919281221eb9a5f1d105">end</a> ()=0</td></tr>
<tr class="memdesc:a626bd746b3e1919281221eb9a5f1d105"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get an iterator pointing to the end of <code><a class="el" href="a00851.html" title="A SelectResults is obtained by executing a Query on the server.">SelectResults</a></code>. <a href="#a626bd746b3e1919281221eb9a5f1d105">More...</a><br /></td></tr>
<tr class="separator:a626bd746b3e1919281221eb9a5f1d105"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a267694c8d139ff91b578548c907dd083"><td class="memItemLeft" align="right" valign="top">virtual const std::shared_ptr&lt; <a class="el" href="a00855.html">Serializable</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00851.html#a267694c8d139ff91b578548c907dd083">operator[]</a> (size_t index) const =0</td></tr>
<tr class="memdesc:a267694c8d139ff91b578548c907dd083"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index operator to directly access an item in the <a class="el" href="a00851.html" title="A SelectResults is obtained by executing a Query on the server.">SelectResults</a>. <a href="#a267694c8d139ff91b578548c907dd083">More...</a><br /></td></tr>
<tr class="separator:a267694c8d139ff91b578548c907dd083"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8dff8beca5db847869d66d81ea7b85d4"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00851.html#a8dff8beca5db847869d66d81ea7b85d4">size</a> () const =0</td></tr>
<tr class="memdesc:a8dff8beca5db847869d66d81ea7b85d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the size of the <a class="el" href="a00851.html" title="A SelectResults is obtained by executing a Query on the server.">SelectResults</a>. <a href="#a8dff8beca5db847869d66d81ea7b85d4">More...</a><br /></td></tr>
<tr class="separator:a8dff8beca5db847869d66d81ea7b85d4"><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>A <a class="el" href="a00847.html" title="A ResultSet may be obtained after executing a Query which is obtained from a QueryService which in tu...">ResultSet</a> may be obtained after executing a <a class="el" href="a00807.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">Query</a> which is obtained from a <a class="el" href="a00811.html" title="QueryService is the class obtained from a Cache.">QueryService</a> which in turn is obtained from a <a class="el" href="a00287.html" title="Caches are obtained from the create method on the CacheFactory#create class.">Cache</a>. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a51a183166096893fcb16b569327c60b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51a183166096893fcb16b569327c60b3">&#9670;&nbsp;</a></span>iterator</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">typedef std::vector&lt;std::shared_ptr&lt;<a class="el" href="a00855.html">Cacheable</a>&gt; &gt;::<a class="el" href="a00851.html#a51a183166096893fcb16b569327c60b3">iterator</a> <a class="el" href="a00851.html#a51a183166096893fcb16b569327c60b3">apache::geode::client::SelectResults::iterator</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Interface of an iterator for <code><a class="el" href="a00851.html" title="A SelectResults is obtained by executing a Query on the server.">SelectResults</a></code>. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a47897882766667431cdf1eebc1eb00b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47897882766667431cdf1eebc1eb00b3">&#9670;&nbsp;</a></span>begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00851.html#a51a183166096893fcb16b569327c60b3">iterator</a> apache::geode::client::SelectResults::begin </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get an iterator pointing to the start of <code><a class="el" href="a00851.html" title="A SelectResults is obtained by executing a Query on the server.">SelectResults</a></code>. </p>
</div>
</div>
<a id="a626bd746b3e1919281221eb9a5f1d105"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a626bd746b3e1919281221eb9a5f1d105">&#9670;&nbsp;</a></span>end()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00851.html#a51a183166096893fcb16b569327c60b3">iterator</a> apache::geode::client::SelectResults::end </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get an iterator pointing to the end of <code><a class="el" href="a00851.html" title="A SelectResults is obtained by executing a Query on the server.">SelectResults</a></code>. </p>
</div>
</div>
<a id="a267694c8d139ff91b578548c907dd083"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a267694c8d139ff91b578548c907dd083">&#9670;&nbsp;</a></span>operator[]()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const std::shared_ptr&lt;<a class="el" href="a00855.html">Serializable</a>&gt; apache::geode::client::SelectResults::operator[] </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Index operator to directly access an item in the <a class="el" href="a00851.html" title="A SelectResults is obtained by executing a Query on the server.">SelectResults</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>the index number of the required item. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00471.html" title="Thrown when an argument to a method is illegal.">IllegalArgumentException</a></td><td>if the index is out of bounds. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A smart pointer to the item indexed. </dd></dl>
</div>
</div>
<a id="a8dff8beca5db847869d66d81ea7b85d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8dff8beca5db847869d66d81ea7b85d4">&#9670;&nbsp;</a></span>size()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t apache::geode::client::SelectResults::size </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">pure virtual</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the size of the <a class="el" href="a00851.html" title="A SelectResults is obtained by executing a Query on the server.">SelectResults</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>the number of items in the <a class="el" href="a00851.html" title="A SelectResults is obtained by executing a Query on the server.">SelectResults</a>. </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<HR><address style="align: right;"><small>Apache Geode C++ Cache API Documentation</small></address>