blob: b00003864d0640a11de367b8ffe0bd78b59bc87a [file] [log] [blame]
<!-- HTML header for doxygen 1.8.6-->
<!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.9.1"/>
<title>FlatBuffers: flatbuffers::Array&lt; T, length &gt; 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="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>
<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" />
<link href="https://fonts.googleapis.com/css?family=Roboto:300,400,400italic,500,500italic,700,700italic|Roboto+Mono:400,700" rel="stylesheet">
<link href="style.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea" style="height: 110px;">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="commonprojectlogo">
<img alt="Logo" src="fpl_logo_small.png"/>
</td>
<td style="padding-left: 0.5em;">
<div id="projectname">FlatBuffers
</div>
<div style="font-size:12px;">
An open source project by <a href="https://developers.google.com/games/#Tools">FPL</a>.
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @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('classflatbuffers_1_1_array.html',''); initResizable(); });
/* @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> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classflatbuffers_1_1_array-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">flatbuffers::Array&lt; T, length &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<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:a375d371770bbb4ad94311b8f65974ec4"><td class="memItemLeft" align="right" valign="top"><a id="a375d371770bbb4ad94311b8f65974ec4"></a>
typedef <a class="el" href="structflatbuffers_1_1_vector_iterator.html">VectorIterator</a>&lt; T, return_type &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>const_iterator</b></td></tr>
<tr class="separator:a375d371770bbb4ad94311b8f65974ec4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbd9cf3b6515d4eb6af29d493ac4e4be"><td class="memItemLeft" align="right" valign="top"><a id="adbd9cf3b6515d4eb6af29d493ac4e4be"></a>
typedef <a class="el" href="structflatbuffers_1_1_vector_reverse_iterator.html">VectorReverseIterator</a>&lt; <a class="el" href="structflatbuffers_1_1_vector_iterator.html">const_iterator</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>const_reverse_iterator</b></td></tr>
<tr class="separator:adbd9cf3b6515d4eb6af29d493ac4e4be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a252ab64a89bfd61cb7baa5d4b1d74cd3"><td class="memItemLeft" align="right" valign="top"><a id="a252ab64a89bfd61cb7baa5d4b1d74cd3"></a>
typedef <a class="el" href="structflatbuffers_1_1_indirect_helper.html">IndirectHelper</a>&lt; IndirectHelperType &gt;::return_type&#160;</td><td class="memItemRight" valign="bottom"><b>return_type</b></td></tr>
<tr class="separator:a252ab64a89bfd61cb7baa5d4b1d74cd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a695602e3d8b6581bd41aac335be0b909"><td class="memItemLeft" align="right" valign="top"><a id="a695602e3d8b6581bd41aac335be0b909"></a>
typedef uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>size_type</b></td></tr>
<tr class="separator:a695602e3d8b6581bd41aac335be0b909"><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:af9f143cef0786ce109b66145340b79a3"><td class="memItemLeft" align="right" valign="top"><a id="af9f143cef0786ce109b66145340b79a3"></a>
<a class="el" href="structflatbuffers_1_1_vector_iterator.html">const_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><b>begin</b> () const</td></tr>
<tr class="separator:af9f143cef0786ce109b66145340b79a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab77a4e365df1c8f92b23ba290850cdcb"><td class="memItemLeft" align="right" valign="top"><a id="ab77a4e365df1c8f92b23ba290850cdcb"></a>
<a class="el" href="structflatbuffers_1_1_vector_iterator.html">const_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><b>cbegin</b> () const</td></tr>
<tr class="separator:ab77a4e365df1c8f92b23ba290850cdcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2965190c2f307ee733bcf06384bf1cbb"><td class="memItemLeft" align="right" valign="top"><a id="a2965190c2f307ee733bcf06384bf1cbb"></a>
<a class="el" href="structflatbuffers_1_1_vector_iterator.html">const_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><b>cend</b> () const</td></tr>
<tr class="separator:a2965190c2f307ee733bcf06384bf1cbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a459e3784ef433678828e1f6dce583754"><td class="memItemLeft" align="right" valign="top"><a id="a459e3784ef433678828e1f6dce583754"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>CopyFromSpan</b> (flatbuffers::span&lt; const T, length &gt; src)</td></tr>
<tr class="separator:a459e3784ef433678828e1f6dce583754"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c44e968453f813e89a6876d91f3a3ac"><td class="memItemLeft" align="right" valign="top"><a id="a0c44e968453f813e89a6876d91f3a3ac"></a>
<a class="el" href="structflatbuffers_1_1_vector_reverse_iterator.html">const_reverse_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><b>crbegin</b> () const</td></tr>
<tr class="separator:a0c44e968453f813e89a6876d91f3a3ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a348aed71a81bf7c9adcc4f7f5d131ce3"><td class="memItemLeft" align="right" valign="top"><a id="a348aed71a81bf7c9adcc4f7f5d131ce3"></a>
<a class="el" href="structflatbuffers_1_1_vector_reverse_iterator.html">const_reverse_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><b>crend</b> () const</td></tr>
<tr class="separator:a348aed71a81bf7c9adcc4f7f5d131ce3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5bb12607269eb1cf857f9401baa307cf"><td class="memItemLeft" align="right" valign="top"><a id="a5bb12607269eb1cf857f9401baa307cf"></a>
uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><b>Data</b> ()</td></tr>
<tr class="separator:a5bb12607269eb1cf857f9401baa307cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e7997cfd51713df087d5524713b20be"><td class="memItemLeft" align="right" valign="top"><a id="a3e7997cfd51713df087d5524713b20be"></a>
T *&#160;</td><td class="memItemRight" valign="bottom"><b>data</b> ()</td></tr>
<tr class="separator:a3e7997cfd51713df087d5524713b20be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9087374e33e30ebe5bef6bfb0bc26d1"><td class="memItemLeft" align="right" valign="top"><a id="ab9087374e33e30ebe5bef6bfb0bc26d1"></a>
const uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><b>Data</b> () const</td></tr>
<tr class="separator:ab9087374e33e30ebe5bef6bfb0bc26d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6df16934979f7d10a366e2877cd5e3f9"><td class="memItemLeft" align="right" valign="top"><a id="a6df16934979f7d10a366e2877cd5e3f9"></a>
const T *&#160;</td><td class="memItemRight" valign="bottom"><b>data</b> () const</td></tr>
<tr class="separator:a6df16934979f7d10a366e2877cd5e3f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79a4f5097c04d03fd32c0c0bc505f77a"><td class="memItemLeft" align="right" valign="top"><a id="a79a4f5097c04d03fd32c0c0bc505f77a"></a>
<a class="el" href="structflatbuffers_1_1_vector_iterator.html">const_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><b>end</b> () const</td></tr>
<tr class="separator:a79a4f5097c04d03fd32c0c0bc505f77a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70d39741861851799c06f757cb06213a"><td class="memItemLeft" align="right" valign="top"><a id="a70d39741861851799c06f757cb06213a"></a>
return_type&#160;</td><td class="memItemRight" valign="bottom"><b>Get</b> (uoffset_t i) const</td></tr>
<tr class="separator:a70d39741861851799c06f757cb06213a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9d081d782c23ad782c9b499ae2e701c"><td class="memTemplParams" colspan="2"><a id="aa9d081d782c23ad782c9b499ae2e701c"></a>
template&lt;typename E &gt; </td></tr>
<tr class="memitem:aa9d081d782c23ad782c9b499ae2e701c"><td class="memTemplItemLeft" align="right" valign="top">E&#160;</td><td class="memTemplItemRight" valign="bottom"><b>GetEnum</b> (uoffset_t i) const</td></tr>
<tr class="separator:aa9d081d782c23ad782c9b499ae2e701c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14aab91bc340064ee5d31dc36ad2ffce"><td class="memItemLeft" align="right" valign="top"><a id="a14aab91bc340064ee5d31dc36ad2ffce"></a>
flatbuffers::conditional&lt; scalar_tag::value, void, T * &gt;::type&#160;</td><td class="memItemRight" valign="bottom"><b>GetMutablePointer</b> (uoffset_t i) const</td></tr>
<tr class="separator:a14aab91bc340064ee5d31dc36ad2ffce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c9b05e49518115552f6f550cd844b64"><td class="memItemLeft" align="right" valign="top"><a id="a2c9b05e49518115552f6f550cd844b64"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Mutate</b> (uoffset_t i, const T &amp;val)</td></tr>
<tr class="separator:a2c9b05e49518115552f6f550cd844b64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb558b81e4f92c2c0b3195c5efceb5b0"><td class="memItemLeft" align="right" valign="top"><a id="abb558b81e4f92c2c0b3195c5efceb5b0"></a>
return_type&#160;</td><td class="memItemRight" valign="bottom"><b>operator[]</b> (uoffset_t i) const</td></tr>
<tr class="separator:abb558b81e4f92c2c0b3195c5efceb5b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af00e71a586f8842a66047806db4a3371"><td class="memItemLeft" align="right" valign="top"><a id="af00e71a586f8842a66047806db4a3371"></a>
<a class="el" href="structflatbuffers_1_1_vector_reverse_iterator.html">const_reverse_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><b>rbegin</b> () const</td></tr>
<tr class="separator:af00e71a586f8842a66047806db4a3371"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1179436593ebd7576a19d884a509cec"><td class="memItemLeft" align="right" valign="top"><a id="ab1179436593ebd7576a19d884a509cec"></a>
<a class="el" href="structflatbuffers_1_1_vector_reverse_iterator.html">const_reverse_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><b>rend</b> () const</td></tr>
<tr class="separator:ab1179436593ebd7576a19d884a509cec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43f5115933697ef5066319dbde1bfc51"><td class="memItemLeft" align="right" valign="top"><a id="a43f5115933697ef5066319dbde1bfc51"></a>
FLATBUFFERS_CONSTEXPR uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>size</b> () const</td></tr>
<tr class="separator:a43f5115933697ef5066319dbde1bfc51"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a8055cdf5a0cc33fde943a169a343af77"><td class="memItemLeft" align="right" valign="top">static FLATBUFFERS_CONSTEXPR bool&#160;</td><td class="memItemRight" valign="bottom"><b>is_span_observable</b></td></tr>
<tr class="separator:a8055cdf5a0cc33fde943a169a343af77"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ab3b8dfa37fdd6ac224fa21b97606d99b"><td class="memItemLeft" align="right" valign="top"><a id="ab3b8dfa37fdd6ac224fa21b97606d99b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>CopyFromSpanImpl</b> (flatbuffers::false_type, flatbuffers::span&lt; const T, length &gt; src)</td></tr>
<tr class="separator:ab3b8dfa37fdd6ac224fa21b97606d99b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7154384b6fd55bd7eb6fea4556b37461"><td class="memItemLeft" align="right" valign="top"><a id="a7154384b6fd55bd7eb6fea4556b37461"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>CopyFromSpanImpl</b> (flatbuffers::true_type, flatbuffers::span&lt; const T, length &gt; src)</td></tr>
<tr class="separator:a7154384b6fd55bd7eb6fea4556b37461"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae824273e4c5e98cdd075100fd2b654ff"><td class="memItemLeft" align="right" valign="top"><a id="ae824273e4c5e98cdd075100fd2b654ff"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>MutateImpl</b> (flatbuffers::false_type, uoffset_t i, const T &amp;val)</td></tr>
<tr class="separator:ae824273e4c5e98cdd075100fd2b654ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8473825261d1fca4e384edfeabc0699a"><td class="memItemLeft" align="right" valign="top"><a id="a8473825261d1fca4e384edfeabc0699a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>MutateImpl</b> (flatbuffers::true_type, uoffset_t i, const T &amp;val)</td></tr>
<tr class="separator:a8473825261d1fca4e384edfeabc0699a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:adfb542aeb0528b606187162ed44952df"><td class="memItemLeft" align="right" valign="top"><a id="adfb542aeb0528b606187162ed44952df"></a>
uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>data_</b> [length *sizeof(T)]</td></tr>
<tr class="separator:adfb542aeb0528b606187162ed44952df"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a8055cdf5a0cc33fde943a169a343af77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8055cdf5a0cc33fde943a169a343af77">&#9670;&nbsp;</a></span>is_span_observable</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , uint16_t length&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">FLATBUFFERS_CONSTEXPR bool <a class="el" href="classflatbuffers_1_1_array.html">flatbuffers::Array</a>&lt; T, length &gt;::is_span_observable</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">=</div>
<div class="line"> (scalar_tag::value &amp;&amp; (FLATBUFFERS_LITTLEENDIAN || <span class="keyword">sizeof</span>(T) == 1)) ||</div>
<div class="line"> !scalar_tag::value</div>
</div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="flatbuffers_8h_source.html">flatbuffers.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- Google Analytics -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-49880327-7', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>