Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 753560b55dbf6656389b95efc8d4df07ac43cc9a / . / Documentation / classarmnn_1_1_exception.html
blob: f031348eb6b4193d3d6316b7a495bcbd7d17735b [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.13"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
8<title>ArmNN: Exception Class Reference</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="navtree.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="resize.js"></script>
14<script type="text/javascript" src="navtreedata.js"></script>
15<script type="text/javascript" src="navtree.js"></script>
16<script type="text/javascript">
17 $(document).ready(initResizable);
18</script>
19<link href="search/search.css" rel="stylesheet" type="text/css"/>
20<script type="text/javascript" src="search/searchdata.js"></script>
21<script type="text/javascript" src="search/search.js"></script>
22<link href="doxygen.css" rel="stylesheet" type="text/css" />
23</head>
24<body>
25<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
26<div id="titlearea">
27<table cellspacing="0" cellpadding="0">
28 <tbody>
29 <tr style="height: 56px;">
30 <td id="projectalign" style="padding-left: 0.5em;">
31 <div id="projectname">ArmNN
32 &#160;<span id="projectnumber">NotReleased</span>
33 </div>
34 </td>
35 </tr>
36 </tbody>
37</table>
38</div>
39<!-- end header part -->
40<!-- Generated by Doxygen 1.8.13 -->
41<script type="text/javascript">
42var searchBox = new SearchBox("searchBox", "search",false,'Search');
43</script>
44<script type="text/javascript" src="menudata.js"></script>
45<script type="text/javascript" src="menu.js"></script>
46<script type="text/javascript">
47$(function() {
48 initMenu('',true,false,'search.php','Search');
49 $(document).ready(function() { init_search(); });
50});
51</script>
52<div id="main-nav"></div>
53</div><!-- top -->
54<div id="side-nav" class="ui-resizable side-nav-resizable">
55 <div id="nav-tree">
56 <div id="nav-tree-contents">
57 <div id="nav-sync" class="sync"></div>
58 </div>
59 </div>
60 <div id="splitbar" style="-moz-user-select:none;"
61 class="ui-resizable-handle">
62 </div>
63</div>
64<script type="text/javascript">
65$(document).ready(function(){initNavTree('classarmnn_1_1_exception.html','');});
66</script>
67<div id="doc-content">
68<!-- window showing the filter options -->
69<div id="MSearchSelectWindow"
70 onmouseover="return searchBox.OnSearchSelectShow()"
71 onmouseout="return searchBox.OnSearchSelectHide()"
72 onkeydown="return searchBox.OnSearchSelectKey(event)">
73</div>
74
75<!-- iframe showing the search results (closed by default) -->
76<div id="MSearchResultsWindow">
77<iframe src="javascript:void(0)" frameborder="0"
78 name="MSearchResults" id="MSearchResults">
79</iframe>
80</div>
81
82<div class="header">
83 <div class="summary">
84<a href="#pub-methods">Public Member Functions</a> &#124;
85<a href="classarmnn_1_1_exception-members.html">List of all members</a> </div>
86 <div class="headertitle">
87<div class="title">Exception Class Reference</div> </div>
88</div><!--header-->
89<div class="contents">
90
91<p>Base class for all ArmNN exceptions so that users can filter to just those.
92 <a href="classarmnn_1_1_exception.html#details">More...</a></p>
93
94<p><code>#include &lt;<a class="el" href="_exceptions_8hpp_source.html">Exceptions.hpp</a>&gt;</code></p>
95<div class="dynheader">
96Inheritance diagram for Exception:</div>
97<div class="dyncontent">
98 <div class="center">
99 <img src="classarmnn_1_1_exception.png" usemap="#Exception_map" alt=""/>
100 <map id="Exception_map" name="Exception_map">
101<area href="classarmnn_1_1_backend_unavailable_exception.html" title="Class for non-fatal exceptions raised while initialising a backend. " alt="BackendUnavailableException" shape="rect" coords="192,112,374,136"/>
102<area href="classarmnn_1_1_bad_optional_access_exception.html" alt="BadOptionalAccessException" shape="rect" coords="192,168,374,192"/>
103<area href="classarmnn_1_1_file_not_found_exception.html" alt="FileNotFoundException" shape="rect" coords="192,224,374,248"/>
104<area href="classarmnn_1_1_graph_validation_exception.html" alt="GraphValidationException" shape="rect" coords="192,280,374,304"/>
105<area href="classarmnn_1_1_invalid_argument_exception.html" alt="InvalidArgumentException" shape="rect" coords="192,336,374,360"/>
106<area href="classarmnn_1_1_layer_validation_exception.html" alt="LayerValidationException" shape="rect" coords="192,392,374,416"/>
107<area href="classarmnn_1_1_memory_export_exception.html" alt="MemoryExportException" shape="rect" coords="192,448,374,472"/>
108<area href="classarmnn_1_1_memory_import_exception.html" alt="MemoryImportException" shape="rect" coords="192,504,374,528"/>
109<area href="classarmnn_1_1_parse_exception.html" alt="ParseException" shape="rect" coords="192,560,374,584"/>
110<area href="classarmnn_1_1profiling_1_1_buffer_exhaustion.html" alt="BufferExhaustion" shape="rect" coords="192,616,374,640"/>
111<area href="classarmnn_1_1_runtime_exception.html" alt="RuntimeException" shape="rect" coords="192,672,374,696"/>
112<area href="classarmnn_1_1test_1_1_test_framework_exception.html" alt="TestFrameworkException" shape="rect" coords="192,728,374,752"/>
113<area href="classarmnn_1_1_timeout_exception.html" alt="TimeoutException" shape="rect" coords="192,784,374,808"/>
114<area href="classarmnn_1_1_unimplemented_exception.html" alt="UnimplementedException" shape="rect" coords="192,840,374,864"/>
115<area href="class_inference_test_image_exception.html" alt="InferenceTestImageException" shape="rect" coords="192,896,374,920"/>
116</map>
117 </div></div>
118<table class="memberdecls">
119<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
120Public Member Functions</h2></td></tr>
121<tr class="memitem:ad56b7b14f59554e891ad88b26cbf8ac3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_exception.html#ad56b7b14f59554e891ad88b26cbf8ac3">Exception</a> (const std::string &amp;message)</td></tr>
122<tr class="separator:ad56b7b14f59554e891ad88b26cbf8ac3"><td class="memSeparator" colspan="2">&#160;</td></tr>
123<tr class="memitem:a9547759a71678ab215a14775db9cd108"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_exception.html#a9547759a71678ab215a14775db9cd108">Exception</a> (const std::string &amp;message, const <a class="el" href="structarmnn_1_1_check_location.html">CheckLocation</a> &amp;location)</td></tr>
124<tr class="separator:a9547759a71678ab215a14775db9cd108"><td class="memSeparator" colspan="2">&#160;</td></tr>
125<tr class="memitem:a1d5973185de48fcc43535e89fded0764"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_exception.html#a1d5973185de48fcc43535e89fded0764">Exception</a> (const <a class="el" href="classarmnn_1_1_exception.html">Exception</a> &amp;other, const std::string &amp;message, const <a class="el" href="structarmnn_1_1_check_location.html">CheckLocation</a> &amp;location)</td></tr>
126<tr class="separator:a1d5973185de48fcc43535e89fded0764"><td class="memSeparator" colspan="2">&#160;</td></tr>
127<tr class="memitem:abf843cbb29dec939d0731e491bab6f70"><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_exception.html#abf843cbb29dec939d0731e491bab6f70">what</a> () const noexcept override</td></tr>
128<tr class="separator:abf843cbb29dec939d0731e491bab6f70"><td class="memSeparator" colspan="2">&#160;</td></tr>
129</table>
130<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
131<div class="textblock"><p>Base class for all ArmNN exceptions so that users can filter to just those. </p>
132
133<p class="definition">Definition at line <a class="el" href="_exceptions_8hpp_source.html#l00046">46</a> of file <a class="el" href="_exceptions_8hpp_source.html">Exceptions.hpp</a>.</p>
134</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
135<a id="ad56b7b14f59554e891ad88b26cbf8ac3"></a>
136<h2 class="memtitle"><span class="permalink"><a href="#ad56b7b14f59554e891ad88b26cbf8ac3">&#9670;&nbsp;</a></span>Exception() <span class="overload">[1/3]</span></h2>
137
138<div class="memitem">
139<div class="memproto">
140<table class="mlabels">
141 <tr>
142 <td class="mlabels-left">
143 <table class="memname">
144 <tr>
145 <td class="memname"><a class="el" href="classarmnn_1_1_exception.html">Exception</a> </td>
146 <td>(</td>
147 <td class="paramtype">const std::string &amp;&#160;</td>
148 <td class="paramname"><em>message</em></td><td>)</td>
149 <td></td>
150 </tr>
151 </table>
152 </td>
153 <td class="mlabels-right">
154<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
155 </tr>
156</table>
157</div><div class="memdoc">
158
159<p class="definition">Definition at line <a class="el" href="_exceptions_8cpp_source.html#l00012">12</a> of file <a class="el" href="_exceptions_8cpp_source.html">Exceptions.cpp</a>.</p>
160<div class="fragment"><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;: m_Message{message}</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;{</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;}</div></div><!-- fragment -->
161</div>
162</div>
163<a id="a9547759a71678ab215a14775db9cd108"></a>
164<h2 class="memtitle"><span class="permalink"><a href="#a9547759a71678ab215a14775db9cd108">&#9670;&nbsp;</a></span>Exception() <span class="overload">[2/3]</span></h2>
165
166<div class="memitem">
167<div class="memproto">
168<table class="mlabels">
169 <tr>
170 <td class="mlabels-left">
171 <table class="memname">
172 <tr>
173 <td class="memname"><a class="el" href="classarmnn_1_1_exception.html">Exception</a> </td>
174 <td>(</td>
175 <td class="paramtype">const std::string &amp;&#160;</td>
176 <td class="paramname"><em>message</em>, </td>
177 </tr>
178 <tr>
179 <td class="paramkey"></td>
180 <td></td>
181 <td class="paramtype">const <a class="el" href="structarmnn_1_1_check_location.html">CheckLocation</a> &amp;&#160;</td>
182 <td class="paramname"><em>location</em>&#160;</td>
183 </tr>
184 <tr>
185 <td></td>
186 <td>)</td>
187 <td></td><td></td>
188 </tr>
189 </table>
190 </td>
191 <td class="mlabels-right">
192<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
193 </tr>
194</table>
195</div><div class="memdoc">
196
197<p class="definition">Definition at line <a class="el" href="_exceptions_8cpp_source.html#l00017">17</a> of file <a class="el" href="_exceptions_8cpp_source.html">Exceptions.cpp</a>.</p>
198<div class="fragment"><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;: m_Message{message}</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;{</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; m_Message += location.AsString();</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;}</div></div><!-- fragment -->
199</div>
200</div>
201<a id="a1d5973185de48fcc43535e89fded0764"></a>
202<h2 class="memtitle"><span class="permalink"><a href="#a1d5973185de48fcc43535e89fded0764">&#9670;&nbsp;</a></span>Exception() <span class="overload">[3/3]</span></h2>
203
204<div class="memitem">
205<div class="memproto">
206<table class="mlabels">
207 <tr>
208 <td class="mlabels-left">
209 <table class="memname">
210 <tr>
211 <td class="memname"><a class="el" href="classarmnn_1_1_exception.html">Exception</a> </td>
212 <td>(</td>
213 <td class="paramtype">const <a class="el" href="classarmnn_1_1_exception.html">Exception</a> &amp;&#160;</td>
214 <td class="paramname"><em>other</em>, </td>
215 </tr>
216 <tr>
217 <td class="paramkey"></td>
218 <td></td>
219 <td class="paramtype">const std::string &amp;&#160;</td>
220 <td class="paramname"><em>message</em>, </td>
221 </tr>
222 <tr>
223 <td class="paramkey"></td>
224 <td></td>
225 <td class="paramtype">const <a class="el" href="structarmnn_1_1_check_location.html">CheckLocation</a> &amp;&#160;</td>
226 <td class="paramname"><em>location</em>&#160;</td>
227 </tr>
228 <tr>
229 <td></td>
230 <td>)</td>
231 <td></td><td></td>
232 </tr>
233 </table>
234 </td>
235 <td class="mlabels-right">
236<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
237 </tr>
238</table>
239</div><div class="memdoc">
240
241<p class="definition">Definition at line <a class="el" href="_exceptions_8cpp_source.html#l00024">24</a> of file <a class="el" href="_exceptions_8cpp_source.html">Exceptions.cpp</a>.</p>
242<div class="fragment"><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;: m_Message{other.m_Message}</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;{</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; m_Message += <span class="stringliteral">&quot;\n&quot;</span> + message + location.AsString();</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;}</div></div><!-- fragment -->
243</div>
244</div>
245<h2 class="groupheader">Member Function Documentation</h2>
246<a id="abf843cbb29dec939d0731e491bab6f70"></a>
247<h2 class="memtitle"><span class="permalink"><a href="#abf843cbb29dec939d0731e491bab6f70">&#9670;&nbsp;</a></span>what()</h2>
248
249<div class="memitem">
250<div class="memproto">
251<table class="mlabels">
252 <tr>
253 <td class="mlabels-left">
254 <table class="memname">
255 <tr>
256 <td class="memname">const char * what </td>
257 <td>(</td>
258 <td class="paramname"></td><td>)</td>
259 <td> const</td>
260 </tr>
261 </table>
262 </td>
263 <td class="mlabels-right">
264<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span><span class="mlabel">noexcept</span></span> </td>
265 </tr>
266</table>
267</div><div class="memdoc">
268
269<p class="definition">Definition at line <a class="el" href="_exceptions_8cpp_source.html#l00032">32</a> of file <a class="el" href="_exceptions_8cpp_source.html">Exceptions.cpp</a>.</p>
270
271<p class="reference">Referenced by <a class="el" href="_dynamic_backend_utils_8cpp_source.html#l00263">DynamicBackendUtils::CreateDynamicBackends()</a>, <a class="el" href="_tf_lite_parser_8cpp_source.html#l00597">TfLiteParser::CreateNetworkFromBinary()</a>, <a class="el" href="_yolo_database_8cpp_source.html#l00075">YoloDatabase::GetTestCaseData()</a>, <a class="el" href="_inference_test_8cpp_source.html#l00120">armnn::test::InferenceTest()</a>, <a class="el" href="_inference_test_8inl_source.html#l00301">armnn::test::InferenceTestMain()</a>, <a class="el" href="_armnn_converter_8cpp_source.html#l00359">main()</a>, <a class="el" href="_network_execution_utils_8hpp_source.html#l00377">MainImpl()</a>, <a class="el" href="_dynamic_backend_utils_8cpp_source.html#l00335">DynamicBackendUtils::RegisterDynamicBackendsImpl()</a>, <a class="el" href="_network_execution_utils_8hpp_source.html#l00520">RunTest()</a>, <a class="el" href="_command_handler_8cpp_source.html#l00034">CommandHandler::Stop()</a>, <a class="el" href="_periodic_counter_capture_8cpp_source.html#l00037">PeriodicCounterCapture::Stop()</a>, <a class="el" href="_profiling_service_8cpp_source.html#l00088">ProfilingService::Update()</a>, <a class="el" href="_gatord_mock_service_8cpp_source.html#l00214">GatordMockService::WaitCommand()</a>, and <a class="el" href="_cl_workload_utils_8hpp_source.html#l00123">armnn::WrapClError()</a>.</p>
272<div class="fragment"><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;{</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordflow">return</span> m_Message.c_str();</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;}</div></div><!-- fragment -->
273</div>
274</div>
275<hr/>The documentation for this class was generated from the following files:<ul>
276<li>include/armnn/<a class="el" href="_exceptions_8hpp_source.html">Exceptions.hpp</a></li>
277<li>src/armnn/<a class="el" href="_exceptions_8cpp_source.html">Exceptions.cpp</a></li>
278</ul>
279</div><!-- contents -->
280</div><!-- doc-content -->
281<!-- start footer part -->
282<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
283 <ul>
284 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_exception.html">Exception</a></li>
285 <li class="footer">Generated on Fri Mar 13 2020 16:07:03 for ArmNN by
286 <a href="http://www.doxygen.org/index.html">
287 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
288 </ul>
289</div>
290</body>
291</html>