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/classarmnn_1_1_exception.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/classarmnn_1_1_exception.html')
-rw-r--r-- | Documentation/classarmnn_1_1_exception.html | 291 |
1 files changed, 291 insertions, 0 deletions
diff --git a/Documentation/classarmnn_1_1_exception.html b/Documentation/classarmnn_1_1_exception.html new file mode 100644 index 0000000000..f031348eb6 --- /dev/null +++ b/Documentation/classarmnn_1_1_exception.html @@ -0,0 +1,291 @@ +<!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: Exception 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> +<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('classarmnn_1_1_exception.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="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="classarmnn_1_1_exception-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">Exception Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Base class for all ArmNN exceptions so that users can filter to just those. + <a href="classarmnn_1_1_exception.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="_exceptions_8hpp_source.html">Exceptions.hpp</a>></code></p> +<div class="dynheader"> +Inheritance diagram for Exception:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classarmnn_1_1_exception.png" usemap="#Exception_map" alt=""/> + <map id="Exception_map" name="Exception_map"> +<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"/> +<area href="classarmnn_1_1_bad_optional_access_exception.html" alt="BadOptionalAccessException" shape="rect" coords="192,168,374,192"/> +<area href="classarmnn_1_1_file_not_found_exception.html" alt="FileNotFoundException" shape="rect" coords="192,224,374,248"/> +<area href="classarmnn_1_1_graph_validation_exception.html" alt="GraphValidationException" shape="rect" coords="192,280,374,304"/> +<area href="classarmnn_1_1_invalid_argument_exception.html" alt="InvalidArgumentException" shape="rect" coords="192,336,374,360"/> +<area href="classarmnn_1_1_layer_validation_exception.html" alt="LayerValidationException" shape="rect" coords="192,392,374,416"/> +<area href="classarmnn_1_1_memory_export_exception.html" alt="MemoryExportException" shape="rect" coords="192,448,374,472"/> +<area href="classarmnn_1_1_memory_import_exception.html" alt="MemoryImportException" shape="rect" coords="192,504,374,528"/> +<area href="classarmnn_1_1_parse_exception.html" alt="ParseException" shape="rect" coords="192,560,374,584"/> +<area href="classarmnn_1_1profiling_1_1_buffer_exhaustion.html" alt="BufferExhaustion" shape="rect" coords="192,616,374,640"/> +<area href="classarmnn_1_1_runtime_exception.html" alt="RuntimeException" shape="rect" coords="192,672,374,696"/> +<area href="classarmnn_1_1test_1_1_test_framework_exception.html" alt="TestFrameworkException" shape="rect" coords="192,728,374,752"/> +<area href="classarmnn_1_1_timeout_exception.html" alt="TimeoutException" shape="rect" coords="192,784,374,808"/> +<area href="classarmnn_1_1_unimplemented_exception.html" alt="UnimplementedException" shape="rect" coords="192,840,374,864"/> +<area href="class_inference_test_image_exception.html" alt="InferenceTestImageException" shape="rect" coords="192,896,374,920"/> +</map> + </div></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:ad56b7b14f59554e891ad88b26cbf8ac3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_exception.html#ad56b7b14f59554e891ad88b26cbf8ac3">Exception</a> (const std::string &message)</td></tr> +<tr class="separator:ad56b7b14f59554e891ad88b26cbf8ac3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9547759a71678ab215a14775db9cd108"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_exception.html#a9547759a71678ab215a14775db9cd108">Exception</a> (const std::string &message, const <a class="el" href="structarmnn_1_1_check_location.html">CheckLocation</a> &location)</td></tr> +<tr class="separator:a9547759a71678ab215a14775db9cd108"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1d5973185de48fcc43535e89fded0764"><td class="memItemLeft" align="right" valign="top"> </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> &other, const std::string &message, const <a class="el" href="structarmnn_1_1_check_location.html">CheckLocation</a> &location)</td></tr> +<tr class="separator:a1d5973185de48fcc43535e89fded0764"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abf843cbb29dec939d0731e491bab6f70"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_exception.html#abf843cbb29dec939d0731e491bab6f70">what</a> () const noexcept override</td></tr> +<tr class="separator:abf843cbb29dec939d0731e491bab6f70"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Base class for all ArmNN exceptions so that users can filter to just those. </p> + +<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> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="ad56b7b14f59554e891ad88b26cbf8ac3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad56b7b14f59554e891ad88b26cbf8ac3">◆ </a></span>Exception() <span class="overload">[1/3]</span></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="classarmnn_1_1_exception.html">Exception</a> </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>message</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">explicit</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<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> +<div class="fragment"><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> : m_Message{message}</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><!-- fragment --> +</div> +</div> +<a id="a9547759a71678ab215a14775db9cd108"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a9547759a71678ab215a14775db9cd108">◆ </a></span>Exception() <span class="overload">[2/3]</span></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="classarmnn_1_1_exception.html">Exception</a> </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>message</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="structarmnn_1_1_check_location.html">CheckLocation</a> & </td> + <td class="paramname"><em>location</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">explicit</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<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> +<div class="fragment"><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> : m_Message{message}</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  m_Message += location.AsString();</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> }</div></div><!-- fragment --> +</div> +</div> +<a id="a1d5973185de48fcc43535e89fded0764"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1d5973185de48fcc43535e89fded0764">◆ </a></span>Exception() <span class="overload">[3/3]</span></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="classarmnn_1_1_exception.html">Exception</a> </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classarmnn_1_1_exception.html">Exception</a> & </td> + <td class="paramname"><em>other</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>message</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="structarmnn_1_1_check_location.html">CheckLocation</a> & </td> + <td class="paramname"><em>location</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">explicit</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<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> +<div class="fragment"><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> : m_Message{other.m_Message}</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  m_Message += <span class="stringliteral">"\n"</span> + message + location.AsString();</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> }</div></div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="abf843cbb29dec939d0731e491bab6f70"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abf843cbb29dec939d0731e491bab6f70">◆ </a></span>what()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">const char * what </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span><span class="mlabel">noexcept</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<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> + +<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> +<div class="fragment"><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordflow">return</span> m_Message.c_str();</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> }</div></div><!-- fragment --> +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>include/armnn/<a class="el" href="_exceptions_8hpp_source.html">Exceptions.hpp</a></li> +<li>src/armnn/<a class="el" href="_exceptions_8cpp_source.html">Exceptions.cpp</a></li> +</ul> +</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="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_exception.html">Exception</a></li> + <li class="footer">Generated on Fri Mar 13 2020 16:07:03 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> |