VMware Tanzu GemFire Native C++ Reference  10.1.5
SelectResults.hpp
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #pragma once
19 
20 #ifndef GEODE_SELECTRESULTS_H_
21 #define GEODE_SELECTRESULTS_H_
22 
27 #include "CacheableBuiltins.hpp"
28 #include "ExceptionTypes.hpp"
29 #include "Serializable.hpp"
30 #include "internal/geode_globals.hpp"
31 
32 namespace apache {
33 namespace geode {
34 namespace client {
35 
36 class SelectResultsIterator;
37 
44 class APACHE_GEODE_EXPORT SelectResults {
45  public:
46  virtual ~SelectResults() noexcept = default;
47 
53  virtual size_t size() const = 0;
54 
62  virtual const std::shared_ptr<Serializable> operator[](
63  size_t index) const = 0;
64 
68  typedef std::vector<std::shared_ptr<Cacheable>>::iterator iterator;
69 
73  virtual iterator begin() = 0;
74 
78  virtual iterator end() = 0;
79 };
80 } // namespace client
81 } // namespace geode
82 } // namespace apache
83 
84 #endif // GEODE_SELECTRESULTS_H_
apache::geode::client::SelectResults::size
virtual size_t size() const =0
Get the size of the SelectResults.
apache::geode::client::SelectResults::operator[]
virtual const std::shared_ptr< Serializable > operator[](size_t index) const =0
Index operator to directly access an item in the SelectResults.
apache::geode::client::SelectResults::begin
virtual iterator begin()=0
Get an iterator pointing to the start of SelectResults.
CacheableBuiltins.hpp
Contains generic template definitions for Cacheable types and instantiations for built-in types.
apache::geode::client::SelectResults::end
virtual iterator end()=0
Get an iterator pointing to the end of SelectResults.
apache::geode::client::SelectResults::iterator
std::vector< std::shared_ptr< Cacheable > >::iterator iterator
Interface of an iterator for SelectResults.
Definition: SelectResults.hpp:68
apache::geode::client::SelectResults
A SelectResults is obtained by executing a Query on the server.
Definition: SelectResults.hpp:44

Apache Geode C++ Cache API Documentation