Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 36eed46563a2a254e674865eb8ede62a1558c997 / . / Documentation / classarmnn_1_1_event.xhtml
blob: 130e42dc02a5a7616f95070b57aec669daf77e9c [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: Event 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_event.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-types">Public Types</a> &#124;
99<a href="#pub-methods">Public Member Functions</a> &#124;
100<a href="classarmnn_1_1_event-members.xhtml">List of all members</a> </div>
101 <div class="headertitle">
102<div class="title">Event Class Reference</div> </div>
103</div><!--header-->
104<div class="contents">
105
106<p><a class="el" href="classarmnn_1_1_event.xhtml" title="Event class records measurements reported by BeginEvent()/EndEvent() and returns measurements when Ev...">Event</a> class records measurements reported by BeginEvent()/EndEvent() and returns measurements when <a class="el" href="classarmnn_1_1_event.xhtml#aa75e3a38ab9fee7b2ad5522e746ad0af" title="Get the recorded measurements calculated between Start() and Stop() ">Event::GetMeasurements()</a> is called.
107 <a href="classarmnn_1_1_event.xhtml#details">More...</a></p>
108
109<p><code>#include &lt;<a class="el" href="_profiling_event_8hpp_source.xhtml">ProfilingEvent.hpp</a>&gt;</code></p>
110<table class="memberdecls">
111<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
112Public Types</h2></td></tr>
113<tr class="memitem:a70926d23f3aef7e657a9057a7badb014"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#a70926d23f3aef7e657a9057a7badb014">InstrumentPtr</a> = std::unique_ptr&lt; <a class="el" href="classarmnn_1_1_instrument.xhtml">Instrument</a> &gt;</td></tr>
114<tr class="separator:a70926d23f3aef7e657a9057a7badb014"><td class="memSeparator" colspan="2">&#160;</td></tr>
115<tr class="memitem:a6e9642e693a4c5b8f1b8259844ef4feb"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#a6e9642e693a4c5b8f1b8259844ef4feb">Instruments</a> = std::vector&lt; <a class="el" href="classarmnn_1_1_event.xhtml#a70926d23f3aef7e657a9057a7badb014">InstrumentPtr</a> &gt;</td></tr>
116<tr class="separator:a6e9642e693a4c5b8f1b8259844ef4feb"><td class="memSeparator" colspan="2">&#160;</td></tr>
117</table><table class="memberdecls">
118<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
119Public Member Functions</h2></td></tr>
120<tr class="memitem:a646c2ba712d97f26eb5b0e77e59d1722"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#a646c2ba712d97f26eb5b0e77e59d1722">Event</a> (const std::string &amp;eventName, <a class="el" href="classarmnn_1_1_profiler.xhtml">Profiler</a> *profiler, <a class="el" href="classarmnn_1_1_event.xhtml">Event</a> *parent, const <a class="el" href="classarmnn_1_1_backend_id.xhtml">BackendId</a> backendId, std::vector&lt; <a class="el" href="classarmnn_1_1_event.xhtml#a70926d23f3aef7e657a9057a7badb014">InstrumentPtr</a> &gt; &amp;&amp;instrument)</td></tr>
121<tr class="separator:a646c2ba712d97f26eb5b0e77e59d1722"><td class="memSeparator" colspan="2">&#160;</td></tr>
122<tr class="memitem:a32713cc0b66b7e7e23def4eb53ae3795"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#a32713cc0b66b7e7e23def4eb53ae3795">Event</a> (const <a class="el" href="classarmnn_1_1_event.xhtml">Event</a> &amp;other)=delete</td></tr>
123<tr class="separator:a32713cc0b66b7e7e23def4eb53ae3795"><td class="memSeparator" colspan="2">&#160;</td></tr>
124<tr class="memitem:adc2da08403f870c8a4022f308ec76c7b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#adc2da08403f870c8a4022f308ec76c7b">Event</a> (<a class="el" href="classarmnn_1_1_event.xhtml">Event</a> &amp;&amp;other) noexcept</td></tr>
125<tr class="memdesc:adc2da08403f870c8a4022f308ec76c7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move Constructor. <a href="#adc2da08403f870c8a4022f308ec76c7b">More...</a><br /></td></tr>
126<tr class="separator:adc2da08403f870c8a4022f308ec76c7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
127<tr class="memitem:aed10f5e4b5520fcb155518eebd8993c4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#aed10f5e4b5520fcb155518eebd8993c4">~Event</a> () noexcept</td></tr>
128<tr class="memdesc:aed10f5e4b5520fcb155518eebd8993c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#aed10f5e4b5520fcb155518eebd8993c4">More...</a><br /></td></tr>
129<tr class="separator:aed10f5e4b5520fcb155518eebd8993c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
130<tr class="memitem:a07aaf1227e4d645f15e0a964f54ef291"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#a07aaf1227e4d645f15e0a964f54ef291">Start</a> ()</td></tr>
131<tr class="memdesc:a07aaf1227e4d645f15e0a964f54ef291"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the <a class="el" href="classarmnn_1_1_event.xhtml" title="Event class records measurements reported by BeginEvent()/EndEvent() and returns measurements when Ev...">Event</a>. <a href="#a07aaf1227e4d645f15e0a964f54ef291">More...</a><br /></td></tr>
132<tr class="separator:a07aaf1227e4d645f15e0a964f54ef291"><td class="memSeparator" colspan="2">&#160;</td></tr>
133<tr class="memitem:a17a237457e57625296e6b24feb19c60a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#a17a237457e57625296e6b24feb19c60a">Stop</a> ()</td></tr>
134<tr class="memdesc:a17a237457e57625296e6b24feb19c60a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop the <a class="el" href="classarmnn_1_1_event.xhtml" title="Event class records measurements reported by BeginEvent()/EndEvent() and returns measurements when Ev...">Event</a>. <a href="#a17a237457e57625296e6b24feb19c60a">More...</a><br /></td></tr>
135<tr class="separator:a17a237457e57625296e6b24feb19c60a"><td class="memSeparator" colspan="2">&#160;</td></tr>
136<tr class="memitem:aa75e3a38ab9fee7b2ad5522e746ad0af"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; <a class="el" href="structarmnn_1_1_measurement.xhtml">Measurement</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#aa75e3a38ab9fee7b2ad5522e746ad0af">GetMeasurements</a> () const</td></tr>
137<tr class="memdesc:aa75e3a38ab9fee7b2ad5522e746ad0af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the recorded measurements calculated between <a class="el" href="classarmnn_1_1_event.xhtml#a07aaf1227e4d645f15e0a964f54ef291" title="Start the Event. ">Start()</a> and <a class="el" href="classarmnn_1_1_event.xhtml#a17a237457e57625296e6b24feb19c60a" title="Stop the Event. ">Stop()</a> <a href="#aa75e3a38ab9fee7b2ad5522e746ad0af">More...</a><br /></td></tr>
138<tr class="separator:aa75e3a38ab9fee7b2ad5522e746ad0af"><td class="memSeparator" colspan="2">&#160;</td></tr>
139<tr class="memitem:a55466a39638bb671b24a82941aa37d77"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#a55466a39638bb671b24a82941aa37d77">GetName</a> () const</td></tr>
140<tr class="memdesc:a55466a39638bb671b24a82941aa37d77"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the name of the event. <a href="#a55466a39638bb671b24a82941aa37d77">More...</a><br /></td></tr>
141<tr class="separator:a55466a39638bb671b24a82941aa37d77"><td class="memSeparator" colspan="2">&#160;</td></tr>
142<tr class="memitem:a173e0f41677500fcbcf5b27a52d1caf2"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarmnn_1_1_profiler.xhtml">Profiler</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#a173e0f41677500fcbcf5b27a52d1caf2">GetProfiler</a> () const</td></tr>
143<tr class="memdesc:a173e0f41677500fcbcf5b27a52d1caf2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the pointer of the profiler associated with this event. <a href="#a173e0f41677500fcbcf5b27a52d1caf2">More...</a><br /></td></tr>
144<tr class="separator:a173e0f41677500fcbcf5b27a52d1caf2"><td class="memSeparator" colspan="2">&#160;</td></tr>
145<tr class="memitem:a0ef4ff725b1ce859c6ef32e99e92dba3"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarmnn_1_1_event.xhtml">Event</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#a0ef4ff725b1ce859c6ef32e99e92dba3">GetParentEvent</a> () const</td></tr>
146<tr class="memdesc:a0ef4ff725b1ce859c6ef32e99e92dba3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the pointer of the parent event. <a href="#a0ef4ff725b1ce859c6ef32e99e92dba3">More...</a><br /></td></tr>
147<tr class="separator:a0ef4ff725b1ce859c6ef32e99e92dba3"><td class="memSeparator" colspan="2">&#160;</td></tr>
148<tr class="memitem:aa58c448afeade37f3b23f4842d46d9b5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1_backend_id.xhtml">BackendId</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#aa58c448afeade37f3b23f4842d46d9b5">GetBackendId</a> () const</td></tr>
149<tr class="memdesc:aa58c448afeade37f3b23f4842d46d9b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the backend id of the event. <a href="#aa58c448afeade37f3b23f4842d46d9b5">More...</a><br /></td></tr>
150<tr class="separator:aa58c448afeade37f3b23f4842d46d9b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
151<tr class="memitem:ab4b4d4f416d173cb297360ec636f72c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1_event.xhtml">Event</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#ab4b4d4f416d173cb297360ec636f72c2">operator=</a> (const <a class="el" href="classarmnn_1_1_event.xhtml">Event</a> &amp;other)=delete</td></tr>
152<tr class="memdesc:ab4b4d4f416d173cb297360ec636f72c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator. <a href="#ab4b4d4f416d173cb297360ec636f72c2">More...</a><br /></td></tr>
153<tr class="separator:ab4b4d4f416d173cb297360ec636f72c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
154<tr class="memitem:a776f936d6beb1089963c3ba7b0235c1e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1_event.xhtml">Event</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#a776f936d6beb1089963c3ba7b0235c1e">operator=</a> (<a class="el" href="classarmnn_1_1_event.xhtml">Event</a> &amp;&amp;other) noexcept</td></tr>
155<tr class="memdesc:a776f936d6beb1089963c3ba7b0235c1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move Assignment operator. <a href="#a776f936d6beb1089963c3ba7b0235c1e">More...</a><br /></td></tr>
156<tr class="separator:a776f936d6beb1089963c3ba7b0235c1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
157</table>
158<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
159<div class="textblock"><p><a class="el" href="classarmnn_1_1_event.xhtml" title="Event class records measurements reported by BeginEvent()/EndEvent() and returns measurements when Ev...">Event</a> class records measurements reported by BeginEvent()/EndEvent() and returns measurements when <a class="el" href="classarmnn_1_1_event.xhtml#aa75e3a38ab9fee7b2ad5522e746ad0af" title="Get the recorded measurements calculated between Start() and Stop() ">Event::GetMeasurements()</a> is called. </p>
160
161<p class="definition">Definition at line <a class="el" href="_profiling_event_8hpp_source.xhtml#l00023">23</a> of file <a class="el" href="_profiling_event_8hpp_source.xhtml">ProfilingEvent.hpp</a>.</p>
162</div><h2 class="groupheader">Member Typedef Documentation</h2>
163<a id="a70926d23f3aef7e657a9057a7badb014"></a>
164<h2 class="memtitle"><span class="permalink"><a href="#a70926d23f3aef7e657a9057a7badb014">&#9670;&nbsp;</a></span>InstrumentPtr</h2>
165
166<div class="memitem">
167<div class="memproto">
168 <table class="memname">
169 <tr>
170 <td class="memname">using <a class="el" href="classarmnn_1_1_event.xhtml#a70926d23f3aef7e657a9057a7badb014">InstrumentPtr</a> = std::unique_ptr&lt;<a class="el" href="classarmnn_1_1_instrument.xhtml">Instrument</a>&gt;</td>
171 </tr>
172 </table>
173</div><div class="memdoc">
174
175<p class="definition">Definition at line <a class="el" href="_profiling_event_8hpp_source.xhtml#l00026">26</a> of file <a class="el" href="_profiling_event_8hpp_source.xhtml">ProfilingEvent.hpp</a>.</p>
176
177</div>
178</div>
179<a id="a6e9642e693a4c5b8f1b8259844ef4feb"></a>
180<h2 class="memtitle"><span class="permalink"><a href="#a6e9642e693a4c5b8f1b8259844ef4feb">&#9670;&nbsp;</a></span>Instruments</h2>
181
182<div class="memitem">
183<div class="memproto">
184 <table class="memname">
185 <tr>
186 <td class="memname">using <a class="el" href="classarmnn_1_1_event.xhtml#a6e9642e693a4c5b8f1b8259844ef4feb">Instruments</a> = std::vector&lt;<a class="el" href="classarmnn_1_1_event.xhtml#a70926d23f3aef7e657a9057a7badb014">InstrumentPtr</a>&gt;</td>
187 </tr>
188 </table>
189</div><div class="memdoc">
190
191<p class="definition">Definition at line <a class="el" href="_profiling_event_8hpp_source.xhtml#l00027">27</a> of file <a class="el" href="_profiling_event_8hpp_source.xhtml">ProfilingEvent.hpp</a>.</p>
192
193</div>
194</div>
195<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
196<a id="a646c2ba712d97f26eb5b0e77e59d1722"></a>
197<h2 class="memtitle"><span class="permalink"><a href="#a646c2ba712d97f26eb5b0e77e59d1722">&#9670;&nbsp;</a></span>Event() <span class="overload">[1/3]</span></h2>
198
199<div class="memitem">
200<div class="memproto">
201 <table class="memname">
202 <tr>
203 <td class="memname"><a class="el" href="classarmnn_1_1_event.xhtml">Event</a> </td>
204 <td>(</td>
205 <td class="paramtype">const std::string &amp;&#160;</td>
206 <td class="paramname"><em>eventName</em>, </td>
207 </tr>
208 <tr>
209 <td class="paramkey"></td>
210 <td></td>
211 <td class="paramtype"><a class="el" href="classarmnn_1_1_profiler.xhtml">Profiler</a> *&#160;</td>
212 <td class="paramname"><em>profiler</em>, </td>
213 </tr>
214 <tr>
215 <td class="paramkey"></td>
216 <td></td>
217 <td class="paramtype"><a class="el" href="classarmnn_1_1_event.xhtml">Event</a> *&#160;</td>
218 <td class="paramname"><em>parent</em>, </td>
219 </tr>
220 <tr>
221 <td class="paramkey"></td>
222 <td></td>
223 <td class="paramtype">const <a class="el" href="classarmnn_1_1_backend_id.xhtml">BackendId</a>&#160;</td>
224 <td class="paramname"><em>backendId</em>, </td>
225 </tr>
226 <tr>
227 <td class="paramkey"></td>
228 <td></td>
229 <td class="paramtype">std::vector&lt; <a class="el" href="classarmnn_1_1_event.xhtml#a70926d23f3aef7e657a9057a7badb014">InstrumentPtr</a> &gt; &amp;&amp;&#160;</td>
230 <td class="paramname"><em>instrument</em>&#160;</td>
231 </tr>
232 <tr>
233 <td></td>
234 <td>)</td>
235 <td></td><td></td>
236 </tr>
237 </table>
238</div><div class="memdoc">
239
240<p class="definition">Definition at line <a class="el" href="_profiling_event_8cpp_source.xhtml#l00011">11</a> of file <a class="el" href="_profiling_event_8cpp_source.xhtml">ProfilingEvent.cpp</a>.</p>
241<div class="fragment"><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; : m_EventName(eventName)</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; , m_Profiler(profiler)</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; , m_Parent(parent)</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; , m_BackendId(backendId)</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; , m_Instruments(std::move(instruments))</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;{</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;}</div></div><!-- fragment -->
242</div>
243</div>
244<a id="a32713cc0b66b7e7e23def4eb53ae3795"></a>
245<h2 class="memtitle"><span class="permalink"><a href="#a32713cc0b66b7e7e23def4eb53ae3795">&#9670;&nbsp;</a></span>Event() <span class="overload">[2/3]</span></h2>
246
247<div class="memitem">
248<div class="memproto">
249<table class="mlabels">
250 <tr>
251 <td class="mlabels-left">
252 <table class="memname">
253 <tr>
254 <td class="memname"><a class="el" href="classarmnn_1_1_event.xhtml">Event</a> </td>
255 <td>(</td>
256 <td class="paramtype">const <a class="el" href="classarmnn_1_1_event.xhtml">Event</a> &amp;&#160;</td>
257 <td class="paramname"><em>other</em></td><td>)</td>
258 <td></td>
259 </tr>
260 </table>
261 </td>
262 <td class="mlabels-right">
263<span class="mlabels"><span class="mlabel">delete</span></span> </td>
264 </tr>
265</table>
266</div><div class="memdoc">
267
268</div>
269</div>
270<a id="adc2da08403f870c8a4022f308ec76c7b"></a>
271<h2 class="memtitle"><span class="permalink"><a href="#adc2da08403f870c8a4022f308ec76c7b">&#9670;&nbsp;</a></span>Event() <span class="overload">[3/3]</span></h2>
272
273<div class="memitem">
274<div class="memproto">
275<table class="mlabels">
276 <tr>
277 <td class="mlabels-left">
278 <table class="memname">
279 <tr>
280 <td class="memname"><a class="el" href="classarmnn_1_1_event.xhtml">Event</a> </td>
281 <td>(</td>
282 <td class="paramtype"><a class="el" href="classarmnn_1_1_event.xhtml">Event</a> &amp;&amp;&#160;</td>
283 <td class="paramname"><em>other</em></td><td>)</td>
284 <td></td>
285 </tr>
286 </table>
287 </td>
288 <td class="mlabels-right">
289<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
290 </tr>
291</table>
292</div><div class="memdoc">
293
294<p>Move Constructor. </p>
295
296<p class="definition">Definition at line <a class="el" href="_profiling_event_8cpp_source.xhtml#l00024">24</a> of file <a class="el" href="_profiling_event_8cpp_source.xhtml">ProfilingEvent.cpp</a>.</p>
297<div class="fragment"><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; : m_EventName(std::move(other.m_EventName))</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; , m_Profiler(other.m_Profiler)</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; , m_Parent(other.m_Parent)</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; , m_BackendId(other.m_BackendId)</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; , m_Instruments(std::move(other.m_Instruments))</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;{</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;}</div></div><!-- fragment -->
298</div>
299</div>
300<a id="aed10f5e4b5520fcb155518eebd8993c4"></a>
301<h2 class="memtitle"><span class="permalink"><a href="#aed10f5e4b5520fcb155518eebd8993c4">&#9670;&nbsp;</a></span>~Event()</h2>
302
303<div class="memitem">
304<div class="memproto">
305<table class="mlabels">
306 <tr>
307 <td class="mlabels-left">
308 <table class="memname">
309 <tr>
310 <td class="memname">~<a class="el" href="classarmnn_1_1_event.xhtml">Event</a> </td>
311 <td>(</td>
312 <td class="paramname"></td><td>)</td>
313 <td></td>
314 </tr>
315 </table>
316 </td>
317 <td class="mlabels-right">
318<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
319 </tr>
320</table>
321</div><div class="memdoc">
322
323<p>Destructor. </p>
324
325<p class="definition">Definition at line <a class="el" href="_profiling_event_8cpp_source.xhtml#l00034">34</a> of file <a class="el" href="_profiling_event_8cpp_source.xhtml">ProfilingEvent.cpp</a>.</p>
326<div class="fragment"><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;{</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;}</div></div><!-- fragment -->
327</div>
328</div>
329<h2 class="groupheader">Member Function Documentation</h2>
330<a id="aa58c448afeade37f3b23f4842d46d9b5"></a>
331<h2 class="memtitle"><span class="permalink"><a href="#aa58c448afeade37f3b23f4842d46d9b5">&#9670;&nbsp;</a></span>GetBackendId()</h2>
332
333<div class="memitem">
334<div class="memproto">
335 <table class="memname">
336 <tr>
337 <td class="memname"><a class="el" href="classarmnn_1_1_backend_id.xhtml">BackendId</a> GetBackendId </td>
338 <td>(</td>
339 <td class="paramname"></td><td>)</td>
340 <td> const</td>
341 </tr>
342 </table>
343</div><div class="memdoc">
344
345<p>Get the backend id of the event. </p>
346<dl class="section return"><dt>Returns</dt><dd>Backend id of the event </dd></dl>
347
348<p class="definition">Definition at line <a class="el" href="_profiling_event_8cpp_source.xhtml#l00082">82</a> of file <a class="el" href="_profiling_event_8cpp_source.xhtml">ProfilingEvent.cpp</a>.</p>
349
350<p class="reference">Referenced by <a class="el" href="_profiling_8cpp_source.xhtml#l00115">Profiler::AnalyzeEventSequenceAndWriteResults()</a>.</p>
351<div class="fragment"><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;{</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keywordflow">return</span> m_BackendId;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;}</div></div><!-- fragment -->
352</div>
353</div>
354<a id="aa75e3a38ab9fee7b2ad5522e746ad0af"></a>
355<h2 class="memtitle"><span class="permalink"><a href="#aa75e3a38ab9fee7b2ad5522e746ad0af">&#9670;&nbsp;</a></span>GetMeasurements()</h2>
356
357<div class="memitem">
358<div class="memproto">
359 <table class="memname">
360 <tr>
361 <td class="memname">const std::vector&lt; <a class="el" href="structarmnn_1_1_measurement.xhtml">Measurement</a> &gt; GetMeasurements </td>
362 <td>(</td>
363 <td class="paramname"></td><td>)</td>
364 <td> const</td>
365 </tr>
366 </table>
367</div><div class="memdoc">
368
369<p>Get the recorded measurements calculated between <a class="el" href="classarmnn_1_1_event.xhtml#a07aaf1227e4d645f15e0a964f54ef291" title="Start the Event. ">Start()</a> and <a class="el" href="classarmnn_1_1_event.xhtml#a17a237457e57625296e6b24feb19c60a" title="Stop the Event. ">Stop()</a> </p>
370<dl class="section return"><dt>Returns</dt><dd>Recorded measurements of the event </dd></dl>
371
372<p class="definition">Definition at line <a class="el" href="_profiling_event_8cpp_source.xhtml#l00054">54</a> of file <a class="el" href="_profiling_event_8cpp_source.xhtml">ProfilingEvent.cpp</a>.</p>
373
374<p class="reference">Referenced by <a class="el" href="_profiling_event_test_8cpp_source.xhtml#l00017">BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="_profiling_8cpp_source.xhtml#l00285">armnn::ExtractJsonObjects()</a>, <a class="el" href="_profiling_8cpp_source.xhtml#l00064">armnn::FindKernelMeasurements()</a>, and <a class="el" href="_profiling_8cpp_source.xhtml#l00045">armnn::FindMeasurement()</a>.</p>
375<div class="fragment"><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;{</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; std::vector&lt;Measurement&gt; measurements;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp; instrument : m_Instruments)</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; {</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp; measurement : instrument-&gt;GetMeasurements())</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; {</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; measurements.emplace_back(std::move(measurement));</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; }</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; }</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordflow">return</span> measurements;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;}</div></div><!-- fragment -->
376</div>
377</div>
378<a id="a55466a39638bb671b24a82941aa37d77"></a>
379<h2 class="memtitle"><span class="permalink"><a href="#a55466a39638bb671b24a82941aa37d77">&#9670;&nbsp;</a></span>GetName()</h2>
380
381<div class="memitem">
382<div class="memproto">
383 <table class="memname">
384 <tr>
385 <td class="memname">const std::string &amp; GetName </td>
386 <td>(</td>
387 <td class="paramname"></td><td>)</td>
388 <td> const</td>
389 </tr>
390 </table>
391</div><div class="memdoc">
392
393<p>Get the name of the event. </p>
394<dl class="section return"><dt>Returns</dt><dd>Name of the event </dd></dl>
395
396<p class="definition">Definition at line <a class="el" href="_profiling_event_8cpp_source.xhtml#l00067">67</a> of file <a class="el" href="_profiling_event_8cpp_source.xhtml">ProfilingEvent.cpp</a>.</p>
397
398<p class="reference">Referenced by <a class="el" href="_profiling_8cpp_source.xhtml#l00115">Profiler::AnalyzeEventSequenceAndWriteResults()</a>, <a class="el" href="_profiling_event_test_8cpp_source.xhtml#l00017">BOOST_AUTO_TEST_CASE()</a>, and <a class="el" href="_profiling_8cpp_source.xhtml#l00235">armnn::CalcLevel()</a>.</p>
399<div class="fragment"><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;{</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordflow">return</span> m_EventName;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;}</div></div><!-- fragment -->
400</div>
401</div>
402<a id="a0ef4ff725b1ce859c6ef32e99e92dba3"></a>
403<h2 class="memtitle"><span class="permalink"><a href="#a0ef4ff725b1ce859c6ef32e99e92dba3">&#9670;&nbsp;</a></span>GetParentEvent()</h2>
404
405<div class="memitem">
406<div class="memproto">
407 <table class="memname">
408 <tr>
409 <td class="memname">const <a class="el" href="classarmnn_1_1_event.xhtml">Event</a> * GetParentEvent </td>
410 <td>(</td>
411 <td class="paramname"></td><td>)</td>
412 <td> const</td>
413 </tr>
414 </table>
415</div><div class="memdoc">
416
417<p>Get the pointer of the parent event. </p>
418<dl class="section return"><dt>Returns</dt><dd>Pointer of the parent event </dd></dl>
419
420<p class="definition">Definition at line <a class="el" href="_profiling_event_8cpp_source.xhtml#l00077">77</a> of file <a class="el" href="_profiling_event_8cpp_source.xhtml">ProfilingEvent.cpp</a>.</p>
421
422<p class="reference">Referenced by <a class="el" href="_profiling_event_test_8cpp_source.xhtml#l00017">BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="_profiling_8cpp_source.xhtml#l00235">armnn::CalcLevel()</a>, and <a class="el" href="_profiling_8cpp_source.xhtml#l00218">Profiler::EndEvent()</a>.</p>
423<div class="fragment"><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;{</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordflow">return</span> m_Parent;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;}</div></div><!-- fragment -->
424</div>
425</div>
426<a id="a173e0f41677500fcbcf5b27a52d1caf2"></a>
427<h2 class="memtitle"><span class="permalink"><a href="#a173e0f41677500fcbcf5b27a52d1caf2">&#9670;&nbsp;</a></span>GetProfiler()</h2>
428
429<div class="memitem">
430<div class="memproto">
431 <table class="memname">
432 <tr>
433 <td class="memname">const <a class="el" href="classarmnn_1_1_profiler.xhtml">Profiler</a> * GetProfiler </td>
434 <td>(</td>
435 <td class="paramname"></td><td>)</td>
436 <td> const</td>
437 </tr>
438 </table>
439</div><div class="memdoc">
440
441<p>Get the pointer of the profiler associated with this event. </p>
442<dl class="section return"><dt>Returns</dt><dd>Pointer of the profiler associated with this event </dd></dl>
443
444<p class="definition">Definition at line <a class="el" href="_profiling_event_8cpp_source.xhtml#l00072">72</a> of file <a class="el" href="_profiling_event_8cpp_source.xhtml">ProfilingEvent.cpp</a>.</p>
445<div class="fragment"><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;{</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordflow">return</span> m_Profiler;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;}</div></div><!-- fragment -->
446</div>
447</div>
448<a id="ab4b4d4f416d173cb297360ec636f72c2"></a>
449<h2 class="memtitle"><span class="permalink"><a href="#ab4b4d4f416d173cb297360ec636f72c2">&#9670;&nbsp;</a></span>operator=() <span class="overload">[1/2]</span></h2>
450
451<div class="memitem">
452<div class="memproto">
453<table class="mlabels">
454 <tr>
455 <td class="mlabels-left">
456 <table class="memname">
457 <tr>
458 <td class="memname"><a class="el" href="classarmnn_1_1_event.xhtml">Event</a>&amp; operator= </td>
459 <td>(</td>
460 <td class="paramtype">const <a class="el" href="classarmnn_1_1_event.xhtml">Event</a> &amp;&#160;</td>
461 <td class="paramname"><em>other</em></td><td>)</td>
462 <td></td>
463 </tr>
464 </table>
465 </td>
466 <td class="mlabels-right">
467<span class="mlabels"><span class="mlabel">delete</span></span> </td>
468 </tr>
469</table>
470</div><div class="memdoc">
471
472<p>Assignment operator. </p>
473
474</div>
475</div>
476<a id="a776f936d6beb1089963c3ba7b0235c1e"></a>
477<h2 class="memtitle"><span class="permalink"><a href="#a776f936d6beb1089963c3ba7b0235c1e">&#9670;&nbsp;</a></span>operator=() <span class="overload">[2/2]</span></h2>
478
479<div class="memitem">
480<div class="memproto">
481<table class="mlabels">
482 <tr>
483 <td class="mlabels-left">
484 <table class="memname">
485 <tr>
486 <td class="memname"><a class="el" href="classarmnn_1_1_event.xhtml">Event</a> &amp; operator= </td>
487 <td>(</td>
488 <td class="paramtype"><a class="el" href="classarmnn_1_1_event.xhtml">Event</a> &amp;&amp;&#160;</td>
489 <td class="paramname"><em>other</em></td><td>)</td>
490 <td></td>
491 </tr>
492 </table>
493 </td>
494 <td class="mlabels-right">
495<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
496 </tr>
497</table>
498</div><div class="memdoc">
499
500<p>Move Assignment operator. </p>
501
502<p class="definition">Definition at line <a class="el" href="_profiling_event_8cpp_source.xhtml#l00087">87</a> of file <a class="el" href="_profiling_event_8cpp_source.xhtml">ProfilingEvent.cpp</a>.</p>
503<div class="fragment"><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;{</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keywordflow">if</span> (<span class="keyword">this</span> == &amp;other)</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; {</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; }</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; m_EventName = other.m_EventName;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; m_Profiler = other.m_Profiler;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; m_Parent = other.m_Parent;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; m_BackendId = other.m_BackendId;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; other.m_Profiler = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; other.m_Parent = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;}</div></div><!-- fragment -->
504</div>
505</div>
506<a id="a07aaf1227e4d645f15e0a964f54ef291"></a>
507<h2 class="memtitle"><span class="permalink"><a href="#a07aaf1227e4d645f15e0a964f54ef291">&#9670;&nbsp;</a></span>Start()</h2>
508
509<div class="memitem">
510<div class="memproto">
511 <table class="memname">
512 <tr>
513 <td class="memname">void Start </td>
514 <td>(</td>
515 <td class="paramname"></td><td>)</td>
516 <td></td>
517 </tr>
518 </table>
519</div><div class="memdoc">
520
521<p>Start the <a class="el" href="classarmnn_1_1_event.xhtml" title="Event class records measurements reported by BeginEvent()/EndEvent() and returns measurements when Ev...">Event</a>. </p>
522
523<p class="definition">Definition at line <a class="el" href="_profiling_event_8cpp_source.xhtml#l00038">38</a> of file <a class="el" href="_profiling_event_8cpp_source.xhtml">ProfilingEvent.cpp</a>.</p>
524
525<p class="reference">Referenced by <a class="el" href="_profiling_event_test_8cpp_source.xhtml#l00017">BOOST_AUTO_TEST_CASE()</a>.</p>
526<div class="fragment"><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;{</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp; instrument : m_Instruments)</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; instrument-&gt;Start();</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; }</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;}</div></div><!-- fragment -->
527</div>
528</div>
529<a id="a17a237457e57625296e6b24feb19c60a"></a>
530<h2 class="memtitle"><span class="permalink"><a href="#a17a237457e57625296e6b24feb19c60a">&#9670;&nbsp;</a></span>Stop()</h2>
531
532<div class="memitem">
533<div class="memproto">
534 <table class="memname">
535 <tr>
536 <td class="memname">void Stop </td>
537 <td>(</td>
538 <td class="paramname"></td><td>)</td>
539 <td></td>
540 </tr>
541 </table>
542</div><div class="memdoc">
543
544<p>Stop the <a class="el" href="classarmnn_1_1_event.xhtml" title="Event class records measurements reported by BeginEvent()/EndEvent() and returns measurements when Ev...">Event</a>. </p>
545
546<p class="definition">Definition at line <a class="el" href="_profiling_event_8cpp_source.xhtml#l00046">46</a> of file <a class="el" href="_profiling_event_8cpp_source.xhtml">ProfilingEvent.cpp</a>.</p>
547
548<p class="reference">Referenced by <a class="el" href="_profiling_event_test_8cpp_source.xhtml#l00017">BOOST_AUTO_TEST_CASE()</a>.</p>
549<div class="fragment"><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;{</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp; instrument : m_Instruments)</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; {</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; instrument-&gt;Stop();</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; }</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;}</div></div><!-- fragment -->
550</div>
551</div>
552<hr/>The documentation for this class was generated from the following files:<ul>
553<li>src/armnn/<a class="el" href="_profiling_event_8hpp_source.xhtml">ProfilingEvent.hpp</a></li>
554<li>src/armnn/<a class="el" href="_profiling_event_8cpp_source.xhtml">ProfilingEvent.cpp</a></li>
555</ul>
556</div><!-- contents -->
557</div><!-- doc-content -->
558<!-- start footer part -->
559<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
560 <ul>
561 <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_event.xhtml">Event</a></li>
562 <li class="footer">Generated on Fri Mar 13 2020 16:09:17 for ArmNN by
563 <a href="http://www.doxygen.org/index.html">
564 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
565 </ul>
566</div>
567</body>
568</html>