diff options
author | Ryan OShea <Ryan.OShea2@arm.com> | 2020-03-13 16:26:19 +0000 |
---|---|---|
committer | Ryan OShea <Ryan.OShea2@arm.com> | 2020-03-13 16:26:19 +0000 |
commit | de36e4a9c299028e792c3a5bd99ad0816d806077 (patch) | |
tree | 6c71d89db68da1033bb422253cee2970580ed692 /Documentation/_packet_buffer_8cpp_source.html | |
parent | 78b26f024641e763c7252198339c83bad8c0982f (diff) | |
download | armnn-de36e4a9c299028e792c3a5bd99ad0816d806077.tar.gz |
IVGCVSW-3726 Upload ArmNN Doxygen files
* Upload current ArmNN Doxygen files
Signed-off-by: Ryan OShea <Ryan.OShea2@arm.com>
Change-Id: I8989ed16ee40a99a4495b100bd009cf3e24a7285
Diffstat (limited to 'Documentation/_packet_buffer_8cpp_source.html')
-rw-r--r-- | Documentation/_packet_buffer_8cpp_source.html | 110 |
1 files changed, 110 insertions, 0 deletions
diff --git a/Documentation/_packet_buffer_8cpp_source.html b/Documentation/_packet_buffer_8cpp_source.html new file mode 100644 index 0000000000..015d6758c3 --- /dev/null +++ b/Documentation/_packet_buffer_8cpp_source.html @@ -0,0 +1,110 @@ +<!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.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>ArmNN: src/profiling/PacketBuffer.cpp Source File</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"> + $(document).ready(initResizable); +</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">ArmNN +  <span id="projectnumber">NotReleased</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</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"> +$(document).ready(function(){initNavTree('_packet_buffer_8cpp_source.html','');}); +</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="headertitle"> +<div class="title">PacketBuffer.cpp</div> </div> +</div><!--header--> +<div class="contents"> +<a href="_packet_buffer_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Copyright © 2019 Arm Ltd. All rights reserved.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// SPDX-License-Identifier: MIT</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include "<a class="code" href="_packet_buffer_8hpp.html">PacketBuffer.hpp</a>"</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <<a class="code" href="_exceptions_8hpp.html">armnn/Exceptions.hpp</a>></span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="keyword">namespace </span><a class="code" href="namespacearmnn.html">armnn</a></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> {</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">namespace </span>profiling</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> {</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="classarmnn_1_1profiling_1_1_packet_buffer.html#aa4f3bf029a40855e07f772ab7b25ac05"> 16</a></span> <a class="code" href="classarmnn_1_1profiling_1_1_packet_buffer.html#aa4f3bf029a40855e07f772ab7b25ac05">PacketBuffer::PacketBuffer</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> maxSize)</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  : m_MaxSize(maxSize)</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  , m_Size(0)</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  m_Data = std::make_unique<unsigned char[]>(m_MaxSize);</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> }</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classarmnn_1_1profiling_1_1_packet_buffer.html#a58557b0c5413d3c20ddd80e31eaccaed"> 23</a></span> <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* <a class="code" href="classarmnn_1_1profiling_1_1_packet_buffer.html#a58557b0c5413d3c20ddd80e31eaccaed">PacketBuffer::GetReadableData</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword"></span>{</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keywordflow">return</span> m_Data.get();</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> }</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classarmnn_1_1profiling_1_1_packet_buffer.html#ab03338cef0f6b48d46effb2c2a64407d"> 28</a></span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classarmnn_1_1profiling_1_1_packet_buffer.html#ab03338cef0f6b48d46effb2c2a64407d">PacketBuffer::GetSize</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword"></span>{</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordflow">return</span> m_Size;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> }</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classarmnn_1_1profiling_1_1_packet_buffer.html#aa630bd4c9ada8ab204fbb42651b10613"> 33</a></span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1profiling_1_1_packet_buffer.html#aa630bd4c9ada8ab204fbb42651b10613">PacketBuffer::MarkRead</a>()</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  m_Size = 0;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> }</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classarmnn_1_1profiling_1_1_packet_buffer.html#a1d7238f289009294f40b0b2bcb8d594f"> 38</a></span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1profiling_1_1_packet_buffer.html#a1d7238f289009294f40b0b2bcb8d594f">PacketBuffer::Commit</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size)</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">if</span> (size > m_MaxSize)</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_runtime_exception.html">armnn::RuntimeException</a>(<span class="stringliteral">"Cannot commit ["</span> + std::to_string(size) +</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="stringliteral">"] bytes which is more than the maximum size of the buffer ["</span> + std::to_string(m_MaxSize) + <span class="stringliteral">"]"</span>);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  }</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  m_Size = size;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> }</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classarmnn_1_1profiling_1_1_packet_buffer.html#a1a5dddc8911f6189f9ca01394c59faaf"> 48</a></span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1profiling_1_1_packet_buffer.html#a1a5dddc8911f6189f9ca01394c59faaf">PacketBuffer::Release</a>()</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> {</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  m_Size = 0;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> }</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classarmnn_1_1profiling_1_1_packet_buffer.html#a229b663a5b1c2dd9b97ded0513771fc9"> 53</a></span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* <a class="code" href="classarmnn_1_1profiling_1_1_packet_buffer.html#a229b663a5b1c2dd9b97ded0513771fc9">PacketBuffer::GetWritableData</a>()</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> {</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordflow">return</span> m_Data.get();</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> }</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> } <span class="comment">// namespace profiling</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> } <span class="comment">// namespace armnn</span></div><div class="ttc" id="_exceptions_8hpp_html"><div class="ttname"><a href="_exceptions_8hpp.html">Exceptions.hpp</a></div></div> +<div class="ttc" id="_packet_buffer_8hpp_html"><div class="ttname"><a href="_packet_buffer_8hpp.html">PacketBuffer.hpp</a></div></div> +<div class="ttc" id="classarmnn_1_1profiling_1_1_packet_buffer_html_a1d7238f289009294f40b0b2bcb8d594f"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_packet_buffer.html#a1d7238f289009294f40b0b2bcb8d594f">armnn::profiling::PacketBuffer::Commit</a></div><div class="ttdeci">void Commit(unsigned int size) override</div><div class="ttdef"><b>Definition:</b> <a href="_packet_buffer_8cpp_source.html#l00038">PacketBuffer.cpp:38</a></div></div> +<div class="ttc" id="classarmnn_1_1profiling_1_1_packet_buffer_html_ab03338cef0f6b48d46effb2c2a64407d"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_packet_buffer.html#ab03338cef0f6b48d46effb2c2a64407d">armnn::profiling::PacketBuffer::GetSize</a></div><div class="ttdeci">unsigned int GetSize() const override</div><div class="ttdef"><b>Definition:</b> <a href="_packet_buffer_8cpp_source.html#l00028">PacketBuffer.cpp:28</a></div></div> +<div class="ttc" id="classarmnn_1_1profiling_1_1_packet_buffer_html_aa4f3bf029a40855e07f772ab7b25ac05"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_packet_buffer.html#aa4f3bf029a40855e07f772ab7b25ac05">armnn::profiling::PacketBuffer::PacketBuffer</a></div><div class="ttdeci">PacketBuffer(unsigned int maxSize)</div><div class="ttdef"><b>Definition:</b> <a href="_packet_buffer_8cpp_source.html#l00016">PacketBuffer.cpp:16</a></div></div> +<div class="ttc" id="namespacearmnn_html"><div class="ttname"><a href="namespacearmnn.html">armnn</a></div><div class="ttdef"><b>Definition:</b> <a href="_backend_helper_8hpp_source.html#l00011">BackendHelper.hpp:11</a></div></div> +<div class="ttc" id="classarmnn_1_1_runtime_exception_html"><div class="ttname"><a href="classarmnn_1_1_runtime_exception.html">armnn::RuntimeException</a></div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.html#l00120">Exceptions.hpp:120</a></div></div> +<div class="ttc" id="classarmnn_1_1profiling_1_1_packet_buffer_html_a229b663a5b1c2dd9b97ded0513771fc9"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_packet_buffer.html#a229b663a5b1c2dd9b97ded0513771fc9">armnn::profiling::PacketBuffer::GetWritableData</a></div><div class="ttdeci">unsigned char * GetWritableData() override</div><div class="ttdef"><b>Definition:</b> <a href="_packet_buffer_8cpp_source.html#l00053">PacketBuffer.cpp:53</a></div></div> +<div class="ttc" id="classarmnn_1_1profiling_1_1_packet_buffer_html_a1a5dddc8911f6189f9ca01394c59faaf"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_packet_buffer.html#a1a5dddc8911f6189f9ca01394c59faaf">armnn::profiling::PacketBuffer::Release</a></div><div class="ttdeci">void Release() override</div><div class="ttdef"><b>Definition:</b> <a href="_packet_buffer_8cpp_source.html#l00048">PacketBuffer.cpp:48</a></div></div> +<div class="ttc" id="classarmnn_1_1profiling_1_1_packet_buffer_html_aa630bd4c9ada8ab204fbb42651b10613"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_packet_buffer.html#aa630bd4c9ada8ab204fbb42651b10613">armnn::profiling::PacketBuffer::MarkRead</a></div><div class="ttdeci">void MarkRead() override</div><div class="ttdef"><b>Definition:</b> <a href="_packet_buffer_8cpp_source.html#l00033">PacketBuffer.cpp:33</a></div></div> +<div class="ttc" id="classarmnn_1_1profiling_1_1_packet_buffer_html_a58557b0c5413d3c20ddd80e31eaccaed"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_packet_buffer.html#a58557b0c5413d3c20ddd80e31eaccaed">armnn::profiling::PacketBuffer::GetReadableData</a></div><div class="ttdeci">const unsigned char * GetReadableData() const override</div><div class="ttdef"><b>Definition:</b> <a href="_packet_buffer_8cpp_source.html#l00023">PacketBuffer.cpp:23</a></div></div> +</div><!-- fragment --></div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_637c692f14729569dd2eac0c18e2a54a.html">profiling</a></li><li class="navelem"><a class="el" href="_packet_buffer_8cpp.html">PacketBuffer.cpp</a></li> + <li class="footer">Generated on Fri Mar 13 2020 16:06:58 for ArmNN by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> +</div> +</body> +</html> |