blob: ce471fdf47482436bc4075479c4cb41f502377fe [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: com.google.flatbuffers.ByteVector 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>
<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('classcom_1_1google_1_1flatbuffers_1_1_byte_vector.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-methods">Public Member Functions</a> &#124;
<a href="classcom_1_1google_1_1flatbuffers_1_1_byte_vector-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">com.google.flatbuffers.ByteVector Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Helper type for accessing vector of signed or unsigned 8-bit values.
<a href="classcom_1_1google_1_1flatbuffers_1_1_byte_vector.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for com.google.flatbuffers.ByteVector:</div>
<div class="dyncontent">
<div class="center">
<img src="classcom_1_1google_1_1flatbuffers_1_1_byte_vector.png" alt=""/>
</div></div>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Helper type for accessing vector of signed or unsigned 8-bit values. </p>
</div><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:a59be2927d44c4056f53e2ce6582f2785"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcom_1_1google_1_1flatbuffers_1_1_byte_vector.html">ByteVector</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1google_1_1flatbuffers_1_1_byte_vector.html#a59be2927d44c4056f53e2ce6582f2785">__assign</a> (int vector, ByteBuffer bb)</td></tr>
<tr class="memdesc:a59be2927d44c4056f53e2ce6582f2785"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assigns vector access object to vector data. <a href="classcom_1_1google_1_1flatbuffers_1_1_byte_vector.html#a59be2927d44c4056f53e2ce6582f2785">More...</a><br /></td></tr>
<tr class="separator:a59be2927d44c4056f53e2ce6582f2785"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21d252953da38d6fb626c280f71c7c09"><td class="memItemLeft" align="right" valign="top">byte&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1google_1_1flatbuffers_1_1_byte_vector.html#a21d252953da38d6fb626c280f71c7c09">get</a> (int j)</td></tr>
<tr class="memdesc:a21d252953da38d6fb626c280f71c7c09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the byte at the given index. <a href="classcom_1_1google_1_1flatbuffers_1_1_byte_vector.html#a21d252953da38d6fb626c280f71c7c09">More...</a><br /></td></tr>
<tr class="separator:a21d252953da38d6fb626c280f71c7c09"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adda0a66ec6c6a4a923ab73397b394070"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1google_1_1flatbuffers_1_1_byte_vector.html#adda0a66ec6c6a4a923ab73397b394070">getAsUnsigned</a> (int j)</td></tr>
<tr class="memdesc:adda0a66ec6c6a4a923ab73397b394070"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the byte at the given index, zero-extends it to type int, and returns the result, which is therefore in the range 0 through 255. <a href="classcom_1_1google_1_1flatbuffers_1_1_byte_vector.html#adda0a66ec6c6a4a923ab73397b394070">More...</a><br /></td></tr>
<tr class="separator:adda0a66ec6c6a4a923ab73397b394070"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a59be2927d44c4056f53e2ce6582f2785"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59be2927d44c4056f53e2ce6582f2785">&#9670;&nbsp;</a></span>__assign()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcom_1_1google_1_1flatbuffers_1_1_byte_vector.html">ByteVector</a> com.google.flatbuffers.ByteVector.__assign </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>vector</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ByteBuffer&#160;</td>
<td class="paramname"><em>bb</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Assigns vector access object to vector data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vector</td><td>Start data of a vector. </td></tr>
<tr><td class="paramname">bb</td><td>Table's ByteBuffer. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns current vector access object assigned to vector data whose offset is stored at <code>vector</code>. </dd></dl>
</div>
</div>
<a id="a21d252953da38d6fb626c280f71c7c09"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21d252953da38d6fb626c280f71c7c09">&#9670;&nbsp;</a></span>get()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">byte com.google.flatbuffers.ByteVector.get </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>j</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads the byte at the given index. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">j</td><td>The index from which the byte will be read. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the 8-bit value at the given index. </dd></dl>
</div>
</div>
<a id="adda0a66ec6c6a4a923ab73397b394070"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adda0a66ec6c6a4a923ab73397b394070">&#9670;&nbsp;</a></span>getAsUnsigned()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int com.google.flatbuffers.ByteVector.getAsUnsigned </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>j</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads the byte at the given index, zero-extends it to type int, and returns the result, which is therefore in the range 0 through 255. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">j</td><td>The index from which the byte will be read. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the unsigned 8-bit at the given index. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ByteVector.java</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>