| <!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::Struct 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&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 |
|  <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&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&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&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('a00859.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-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">apache::geode::client::Struct Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A <a class="el" href="a00859.html" title="A Struct has a StructSet as its parent.">Struct</a> has a <a class="el" href="a00863.html" title="A StructSet may be obtained after executing a Query which is obtained from a QueryService which in tu...">StructSet</a> as its parent. |
| <a href="a00859.html#details">More...</a></p> |
| |
| <p>Inherits DataSerializableFixedId_t< internal::DSFid::Struct >.</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:a66dd74c380a2642b2cb05f8802e7a475"><td class="memItemLeft" align="right" valign="top">virtual const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00859.html#a66dd74c380a2642b2cb05f8802e7a475">getFieldName</a> (const int32_t index) const</td></tr> |
| <tr class="memdesc:a66dd74c380a2642b2cb05f8802e7a475"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the field corresponding to the index number in the <a class="el" href="a00859.html" title="A Struct has a StructSet as its parent.">Struct</a>. <a href="#a66dd74c380a2642b2cb05f8802e7a475">More...</a><br /></td></tr> |
| <tr class="separator:a66dd74c380a2642b2cb05f8802e7a475"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af3561f6eb903165e620e08b16ac88f97"><td class="memItemLeft" align="right" valign="top">const std::shared_ptr< <a class="el" href="a00863.html">StructSet</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00859.html#af3561f6eb903165e620e08b16ac88f97">getStructSet</a> () const</td></tr> |
| <tr class="memdesc:af3561f6eb903165e620e08b16ac88f97"><td class="mdescLeft"> </td><td class="mdescRight">Get the parent <a class="el" href="a00863.html" title="A StructSet may be obtained after executing a Query which is obtained from a QueryService which in tu...">StructSet</a> of this <a class="el" href="a00859.html" title="A Struct has a StructSet as its parent.">Struct</a>. <a href="#af3561f6eb903165e620e08b16ac88f97">More...</a><br /></td></tr> |
| <tr class="separator:af3561f6eb903165e620e08b16ac88f97"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a29dd41b95a5b916ab5a42f0ea27638de"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00859.html#a29dd41b95a5b916ab5a42f0ea27638de">objectSize</a> () const override</td></tr> |
| <tr class="memdesc:a29dd41b95a5b916ab5a42f0ea27638de"><td class="mdescLeft"> </td><td class="mdescRight">always returns 0 <a href="#a29dd41b95a5b916ab5a42f0ea27638de">More...</a><br /></td></tr> |
| <tr class="separator:a29dd41b95a5b916ab5a42f0ea27638de"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0acfd7c62eb4d7e4ea7a2d542a2a7c51"><td class="memItemLeft" align="right" valign="top">const std::shared_ptr< <a class="el" href="a00855.html">Serializable</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00859.html#a0acfd7c62eb4d7e4ea7a2d542a2a7c51">operator[]</a> (int32_t index) const</td></tr> |
| <tr class="memdesc:a0acfd7c62eb4d7e4ea7a2d542a2a7c51"><td class="mdescLeft"> </td><td class="mdescRight">Get the field value for the given index number. <a href="#a0acfd7c62eb4d7e4ea7a2d542a2a7c51">More...</a><br /></td></tr> |
| <tr class="separator:a0acfd7c62eb4d7e4ea7a2d542a2a7c51"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7eaa1df76584129245dd74e9122c1324"><td class="memItemLeft" align="right" valign="top">const std::shared_ptr< <a class="el" href="a00855.html">Serializable</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00859.html#a7eaa1df76584129245dd74e9122c1324">operator[]</a> (const std::string &fieldName) const</td></tr> |
| <tr class="memdesc:a7eaa1df76584129245dd74e9122c1324"><td class="mdescLeft"> </td><td class="mdescRight">Get the field value for the given field name. <a href="#a7eaa1df76584129245dd74e9122c1324">More...</a><br /></td></tr> |
| <tr class="separator:a7eaa1df76584129245dd74e9122c1324"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5cb924836bf3656cfebd5dbf5b1efc7b"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00859.html#a5cb924836bf3656cfebd5dbf5b1efc7b">size</a> () const</td></tr> |
| <tr class="memdesc:a5cb924836bf3656cfebd5dbf5b1efc7b"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of field values available. <a href="#a5cb924836bf3656cfebd5dbf5b1efc7b">More...</a><br /></td></tr> |
| <tr class="separator:a5cb924836bf3656cfebd5dbf5b1efc7b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8c317d8fd648a26b1d5836e46c2913da"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00859.html#a8c317d8fd648a26b1d5836e46c2913da">Struct</a> (<a class="el" href="a00863.html">StructSet</a> *ssPtr, std::vector< std::shared_ptr< <a class="el" href="a00855.html">Serializable</a> >> &fieldValues)</td></tr> |
| <tr class="memdesc:a8c317d8fd648a26b1d5836e46c2913da"><td class="mdescLeft"> </td><td class="mdescRight">Constructor - meant only for internal use. <a href="#a8c317d8fd648a26b1d5836e46c2913da">More...</a><br /></td></tr> |
| <tr class="separator:a8c317d8fd648a26b1d5836e46c2913da"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a4b8d67f20eaf51ae1a09ee875ba3c0e0"><td class="memItemLeft" align="right" valign="top">static std::shared_ptr< <a class="el" href="a00855.html">Serializable</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00859.html#a4b8d67f20eaf51ae1a09ee875ba3c0e0">createDeserializable</a> ()</td></tr> |
| <tr class="memdesc:a4b8d67f20eaf51ae1a09ee875ba3c0e0"><td class="mdescLeft"> </td><td class="mdescRight">Factory function for registration of <code><a class="el" href="a00859.html" title="A Struct has a StructSet as its parent.">Struct</a></code>. <a href="#a4b8d67f20eaf51ae1a09ee875ba3c0e0">More...</a><br /></td></tr> |
| <tr class="separator:a4b8d67f20eaf51ae1a09ee875ba3c0e0"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A <a class="el" href="a00859.html" title="A Struct has a StructSet as its parent.">Struct</a> has a <a class="el" href="a00863.html" title="A StructSet may be obtained after executing a Query which is obtained from a QueryService which in tu...">StructSet</a> as its parent. </p> |
| <p>It contains the field values returned 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> 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">Constructor & Destructor Documentation</h2> |
| <a id="a8c317d8fd648a26b1d5836e46c2913da"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8c317d8fd648a26b1d5836e46c2913da">◆ </a></span>Struct()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">apache::geode::client::Struct::Struct </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="a00863.html">StructSet</a> * </td> |
| <td class="paramname"><em>ssPtr</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::vector< std::shared_ptr< <a class="el" href="a00855.html">Serializable</a> >> & </td> |
| <td class="paramname"><em>fieldValues</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Constructor - meant only for internal use. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a4b8d67f20eaf51ae1a09ee875ba3c0e0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4b8d67f20eaf51ae1a09ee875ba3c0e0">◆ </a></span>createDeserializable()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static std::shared_ptr<<a class="el" href="a00855.html">Serializable</a>> apache::geode::client::Struct::createDeserializable </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Factory function for registration of <code><a class="el" href="a00859.html" title="A Struct has a StructSet as its parent.">Struct</a></code>. </p> |
| |
| </div> |
| </div> |
| <a id="a66dd74c380a2642b2cb05f8802e7a475"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a66dd74c380a2642b2cb05f8802e7a475">◆ </a></span>getFieldName()</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::string& apache::geode::client::Struct::getFieldName </td> |
| <td>(</td> |
| <td class="paramtype">const int32_t </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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the name of the field corresponding to the index number in the <a class="el" href="a00859.html" title="A Struct has a StructSet as its parent.">Struct</a>. </p> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname">std::out_of_range</td><td>if index is not found </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="af3561f6eb903165e620e08b16ac88f97"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af3561f6eb903165e620e08b16ac88f97">◆ </a></span>getStructSet()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::shared_ptr<<a class="el" href="a00863.html">StructSet</a>> apache::geode::client::Struct::getStructSet </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the parent <a class="el" href="a00863.html" title="A StructSet may be obtained after executing a Query which is obtained from a QueryService which in tu...">StructSet</a> of this <a class="el" href="a00859.html" title="A Struct has a StructSet as its parent.">Struct</a>. </p> |
| <dl class="section return"><dt>Returns</dt><dd>A smart pointer to the parent <a class="el" href="a00863.html" title="A StructSet may be obtained after executing a Query which is obtained from a QueryService which in tu...">StructSet</a> of this <a class="el" href="a00859.html" title="A Struct has a StructSet as its parent.">Struct</a>. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a29dd41b95a5b916ab5a42f0ea27638de"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a29dd41b95a5b916ab5a42f0ea27638de">◆ </a></span>objectSize()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">size_t apache::geode::client::Struct::objectSize </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 class="mlabel">override</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>always returns 0 </p> |
| |
| </div> |
| </div> |
| <a id="a0acfd7c62eb4d7e4ea7a2d542a2a7c51"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0acfd7c62eb4d7e4ea7a2d542a2a7c51">◆ </a></span>operator[]() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::shared_ptr<<a class="el" href="a00855.html">Serializable</a>> apache::geode::client::Struct::operator[] </td> |
| <td>(</td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>index</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the field value for the given index number. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">index</td><td>the index number of the field value to get. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A smart pointer to the field value or nullptr if index out of bounds. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a7eaa1df76584129245dd74e9122c1324"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7eaa1df76584129245dd74e9122c1324">◆ </a></span>operator[]() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const std::shared_ptr<<a class="el" href="a00855.html">Serializable</a>> apache::geode::client::Struct::operator[] </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>fieldName</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the field value for the given field name. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">fieldName</td><td>the name of the field whos value is required. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A smart pointer to the field value. </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 field name is not found. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a5cb924836bf3656cfebd5dbf5b1efc7b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5cb924836bf3656cfebd5dbf5b1efc7b">◆ </a></span>size()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int32_t apache::geode::client::Struct::size </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the number of field values available. </p> |
| <dl class="section return"><dt>Returns</dt><dd>the number of field values available. </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> |
