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