Documentation/classarmnn_1_1_instrument.html

   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: Instrument 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">
  42 var 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_instrument.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_instrument-members.html">List of all members</a>  </div>
  86   <div class="headertitle">
  87 <div class="title">Instrument Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
  88 </div><!--header-->
  89 <div class="contents">
  90
  91 <p><code>#include &lt;<a class="el" href="_instrument_8hpp_source.html">Instrument.hpp</a>&gt;</code></p>
  92 <div class="dynheader">
  93 Inheritance diagram for Instrument:</div>
  94 <div class="dyncontent">
  95  <div class="center">
  96   <img src="classarmnn_1_1_instrument.png" usemap="#Instrument_map" alt=""/>
  97   <map id="Instrument_map" name="Instrument_map">
  98 <area href="classarmnn_1_1_neon_timer.html" alt="NeonTimer" shape="rect" coords="0,56,99,80"/>
  99 <area href="classarmnn_1_1_open_cl_timer.html" title="OpenClTimer instrument that times all OpenCl kernels executed between calls to Start() and Stop()..." alt="OpenClTimer" shape="rect" coords="109,56,208,80"/>
 100 <area href="classarmnn_1_1_wall_clock_timer.html" alt="WallClockTimer" shape="rect" coords="218,56,317,80"/>
 101 </map>
 102  </div></div>
 103 <table class="memberdecls">
 104 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 105 Public Member Functions</h2></td></tr>
 106 <tr class="memitem:a37a2de9b867820a7ab15b8dc8d62b153"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_instrument.html#a37a2de9b867820a7ab15b8dc8d62b153">~Instrument</a> ()</td></tr>
 107 <tr class="separator:a37a2de9b867820a7ab15b8dc8d62b153"><td class="memSeparator" colspan="2">&#160;</td></tr>
 108 <tr class="memitem:a63ce9b9c6710c0dae98f88d6c602313a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_instrument.html#a63ce9b9c6710c0dae98f88d6c602313a">Start</a> ()=0</td></tr>
 109 <tr class="separator:a63ce9b9c6710c0dae98f88d6c602313a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 110 <tr class="memitem:a4d7bebcc22c1b09cf961b83bf84033b6"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_instrument.html#a4d7bebcc22c1b09cf961b83bf84033b6">Stop</a> ()=0</td></tr>
 111 <tr class="separator:a4d7bebcc22c1b09cf961b83bf84033b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 112 <tr class="memitem:a4055fcf05306a7478db7e192cf1e679d"><td class="memItemLeft" align="right" valign="top">virtual std::vector&lt; <a class="el" href="structarmnn_1_1_measurement.html">Measurement</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_instrument.html#a4055fcf05306a7478db7e192cf1e679d">GetMeasurements</a> () const =0</td></tr>
 113 <tr class="separator:a4055fcf05306a7478db7e192cf1e679d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 114 <tr class="memitem:afcc1c3a20bd2860e0ddd21674389246f"><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_instrument.html#afcc1c3a20bd2860e0ddd21674389246f">GetName</a> () const =0</td></tr>
 115 <tr class="separator:afcc1c3a20bd2860e0ddd21674389246f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 116 </table>
 117 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 118 <div class="textblock">
 119 <p class="definition">Definition at line <a class="el" href="_instrument_8hpp_source.html#l00051">51</a> of file <a class="el" href="_instrument_8hpp_source.html">Instrument.hpp</a>.</p>
 120 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 121 <a id="a37a2de9b867820a7ab15b8dc8d62b153"></a>
 122 <h2 class="memtitle"><span class="permalink"><a href="#a37a2de9b867820a7ab15b8dc8d62b153">&#9670;&nbsp;</a></span>~Instrument()</h2>
 123
 124 <div class="memitem">
 125 <div class="memproto">
 126 <table class="mlabels">
 127   <tr>
 128   <td class="mlabels-left">
 129       <table class="memname">
 130         <tr>
 131           <td class="memname">virtual ~<a class="el" href="classarmnn_1_1_instrument.html">Instrument</a> </td>
 132           <td>(</td>
 133           <td class="paramname"></td><td>)</td>
 134           <td></td>
 135         </tr>
 136       </table>
 137   </td>
 138   <td class="mlabels-right">
 139 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
 140   </tr>
 141 </table>
 142 </div><div class="memdoc">
 143
 144 <p class="definition">Definition at line <a class="el" href="_instrument_8hpp_source.html#l00054">54</a> of file <a class="el" href="_instrument_8hpp_source.html">Instrument.hpp</a>.</p>
 145 <div class="fragment"><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;{}</div></div><!-- fragment -->
 146 </div>
 147 </div>
 148 <h2 class="groupheader">Member Function Documentation</h2>
 149 <a id="a4055fcf05306a7478db7e192cf1e679d"></a>
 150 <h2 class="memtitle"><span class="permalink"><a href="#a4055fcf05306a7478db7e192cf1e679d">&#9670;&nbsp;</a></span>GetMeasurements()</h2>
 151
 152 <div class="memitem">
 153 <div class="memproto">
 154 <table class="mlabels">
 155   <tr>
 156   <td class="mlabels-left">
 157       <table class="memname">
 158         <tr>
 159           <td class="memname">virtual std::vector&lt;<a class="el" href="structarmnn_1_1_measurement.html">Measurement</a>&gt; GetMeasurements </td>
 160           <td>(</td>
 161           <td class="paramname"></td><td>)</td>
 162           <td> const</td>
 163         </tr>
 164       </table>
 165   </td>
 166   <td class="mlabels-right">
 167 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 168   </tr>
 169 </table>
 170 </div><div class="memdoc">
 171
 172 <p>Implemented in <a class="el" href="classarmnn_1_1_wall_clock_timer.html#a86ea36032637c02c045f2d433036a203">WallClockTimer</a>, <a class="el" href="classarmnn_1_1_open_cl_timer.html#a86ea36032637c02c045f2d433036a203">OpenClTimer</a>, and <a class="el" href="classarmnn_1_1_neon_timer.html#a86ea36032637c02c045f2d433036a203">NeonTimer</a>.</p>
 173
 174 </div>
 175 </div>
 176 <a id="afcc1c3a20bd2860e0ddd21674389246f"></a>
 177 <h2 class="memtitle"><span class="permalink"><a href="#afcc1c3a20bd2860e0ddd21674389246f">&#9670;&nbsp;</a></span>GetName()</h2>
 178
 179 <div class="memitem">
 180 <div class="memproto">
 181 <table class="mlabels">
 182   <tr>
 183   <td class="mlabels-left">
 184       <table class="memname">
 185         <tr>
 186           <td class="memname">virtual const char* GetName </td>
 187           <td>(</td>
 188           <td class="paramname"></td><td>)</td>
 189           <td> const</td>
 190         </tr>
 191       </table>
 192   </td>
 193   <td class="mlabels-right">
 194 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 195   </tr>
 196 </table>
 197 </div><div class="memdoc">
 198
 199 <p>Implemented in <a class="el" href="classarmnn_1_1_wall_clock_timer.html#ad47edad463024345ce1409153c259215">WallClockTimer</a>, <a class="el" href="classarmnn_1_1_neon_timer.html#ad47edad463024345ce1409153c259215">NeonTimer</a>, and <a class="el" href="classarmnn_1_1_open_cl_timer.html#a7ddf0cf6f620d59c10e63495ace795d0">OpenClTimer</a>.</p>
 200
 201 </div>
 202 </div>
 203 <a id="a63ce9b9c6710c0dae98f88d6c602313a"></a>
 204 <h2 class="memtitle"><span class="permalink"><a href="#a63ce9b9c6710c0dae98f88d6c602313a">&#9670;&nbsp;</a></span>Start()</h2>
 205
 206 <div class="memitem">
 207 <div class="memproto">
 208 <table class="mlabels">
 209   <tr>
 210   <td class="mlabels-left">
 211       <table class="memname">
 212         <tr>
 213           <td class="memname">virtual void Start </td>
 214           <td>(</td>
 215           <td class="paramname"></td><td>)</td>
 216           <td></td>
 217         </tr>
 218       </table>
 219   </td>
 220   <td class="mlabels-right">
 221 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 222   </tr>
 223 </table>
 224 </div><div class="memdoc">
 225
 226 <p>Implemented in <a class="el" href="classarmnn_1_1_wall_clock_timer.html#a156f3866ca69d98b4d9e6e1c1b3ec7da">WallClockTimer</a>, <a class="el" href="classarmnn_1_1_neon_timer.html#a156f3866ca69d98b4d9e6e1c1b3ec7da">NeonTimer</a>, and <a class="el" href="classarmnn_1_1_open_cl_timer.html#a156f3866ca69d98b4d9e6e1c1b3ec7da">OpenClTimer</a>.</p>
 227
 228 </div>
 229 </div>
 230 <a id="a4d7bebcc22c1b09cf961b83bf84033b6"></a>
 231 <h2 class="memtitle"><span class="permalink"><a href="#a4d7bebcc22c1b09cf961b83bf84033b6">&#9670;&nbsp;</a></span>Stop()</h2>
 232
 233 <div class="memitem">
 234 <div class="memproto">
 235 <table class="mlabels">
 236   <tr>
 237   <td class="mlabels-left">
 238       <table class="memname">
 239         <tr>
 240           <td class="memname">virtual void Stop </td>
 241           <td>(</td>
 242           <td class="paramname"></td><td>)</td>
 243           <td></td>
 244         </tr>
 245       </table>
 246   </td>
 247   <td class="mlabels-right">
 248 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 249   </tr>
 250 </table>
 251 </div><div class="memdoc">
 252
 253 <p>Implemented in <a class="el" href="classarmnn_1_1_wall_clock_timer.html#a634c58de2126b4a4e6a2a093e60e1290">WallClockTimer</a>, <a class="el" href="classarmnn_1_1_neon_timer.html#a634c58de2126b4a4e6a2a093e60e1290">NeonTimer</a>, and <a class="el" href="classarmnn_1_1_open_cl_timer.html#a634c58de2126b4a4e6a2a093e60e1290">OpenClTimer</a>.</p>
 254
 255 </div>
 256 </div>
 257 <hr/>The documentation for this class was generated from the following file:<ul>
 258 <li>src/armnn/<a class="el" href="_instrument_8hpp_source.html">Instrument.hpp</a></li>
 259 </ul>
 260 </div><!-- contents -->
 261 </div><!-- doc-content -->
 262 <!-- start footer part -->
 263 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 264   <ul>
 265     <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_instrument.html">Instrument</a></li>
 266     <li class="footer">Generated on Fri Mar 13 2020 16:07:03 for ArmNN by
 267     <a href="http://www.doxygen.org/index.html">
 268     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
 269   </ul>
 270 </div>
 271 </body>
 272 </html>