diff options
Diffstat (limited to '20.02/classarmnn_1_1_event.xhtml')
| -rw-r--r-- | 20.02/classarmnn_1_1_event.xhtml | 568 |
1 files changed, 568 insertions, 0 deletions
diff --git a/20.02/classarmnn_1_1_event.xhtml b/20.02/classarmnn_1_1_event.xhtml new file mode 100644 index 0000000000..130e42dc02 --- /dev/null +++ b/20.02/classarmnn_1_1_event.xhtml @@ -0,0 +1,568 @@ +<!-- Copyright (c) 2020 ARM Limited. --> +<!-- --> +<!-- SPDX-License-Identifier: MIT --> +<!-- --> +<!-- HTML header for doxygen 1.8.13--> +<!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="robots" content="NOINDEX, NOFOLLOW" /> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>ArmNN: Event 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> +<script type="text/x-mathjax-config"> + MathJax.Hub.Config({ + extensions: ["tex2jax.js"], + jax: ["input/TeX","output/HTML-CSS"], +}); +</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="stylesheet.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;"> + <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/> + <td style="padding-left: 0.5em;"> + <div id="projectname"> +  <span id="projectnumber">20.02</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_event.xhtml','');}); +</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-types">Public Types</a> | +<a href="#pub-methods">Public Member Functions</a> | +<a href="classarmnn_1_1_event-members.xhtml">List of all members</a> </div> + <div class="headertitle"> +<div class="title">Event Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<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. + <a href="classarmnn_1_1_event.xhtml#details">More...</a></p> + +<p><code>#include <<a class="el" href="_profiling_event_8hpp_source.xhtml">ProfilingEvent.hpp</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> +Public Types</h2></td></tr> +<tr class="memitem:a70926d23f3aef7e657a9057a7badb014"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#a70926d23f3aef7e657a9057a7badb014">InstrumentPtr</a> = std::unique_ptr< <a class="el" href="classarmnn_1_1_instrument.xhtml">Instrument</a> ></td></tr> +<tr class="separator:a70926d23f3aef7e657a9057a7badb014"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6e9642e693a4c5b8f1b8259844ef4feb"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#a6e9642e693a4c5b8f1b8259844ef4feb">Instruments</a> = std::vector< <a class="el" href="classarmnn_1_1_event.xhtml#a70926d23f3aef7e657a9057a7badb014">InstrumentPtr</a> ></td></tr> +<tr class="separator:a6e9642e693a4c5b8f1b8259844ef4feb"><td class="memSeparator" colspan="2"> </td></tr> +</table><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:a646c2ba712d97f26eb5b0e77e59d1722"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#a646c2ba712d97f26eb5b0e77e59d1722">Event</a> (const std::string &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< <a class="el" href="classarmnn_1_1_event.xhtml#a70926d23f3aef7e657a9057a7badb014">InstrumentPtr</a> > &&instrument)</td></tr> +<tr class="separator:a646c2ba712d97f26eb5b0e77e59d1722"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a32713cc0b66b7e7e23def4eb53ae3795"><td class="memItemLeft" align="right" valign="top"> </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> &other)=delete</td></tr> +<tr class="separator:a32713cc0b66b7e7e23def4eb53ae3795"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:adc2da08403f870c8a4022f308ec76c7b"><td class="memItemLeft" align="right" valign="top"> </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> &&other) noexcept</td></tr> +<tr class="memdesc:adc2da08403f870c8a4022f308ec76c7b"><td class="mdescLeft"> </td><td class="mdescRight">Move Constructor. <a href="#adc2da08403f870c8a4022f308ec76c7b">More...</a><br /></td></tr> +<tr class="separator:adc2da08403f870c8a4022f308ec76c7b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aed10f5e4b5520fcb155518eebd8993c4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#aed10f5e4b5520fcb155518eebd8993c4">~Event</a> () noexcept</td></tr> +<tr class="memdesc:aed10f5e4b5520fcb155518eebd8993c4"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#aed10f5e4b5520fcb155518eebd8993c4">More...</a><br /></td></tr> +<tr class="separator:aed10f5e4b5520fcb155518eebd8993c4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a07aaf1227e4d645f15e0a964f54ef291"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#a07aaf1227e4d645f15e0a964f54ef291">Start</a> ()</td></tr> +<tr class="memdesc:a07aaf1227e4d645f15e0a964f54ef291"><td class="mdescLeft"> </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> +<tr class="separator:a07aaf1227e4d645f15e0a964f54ef291"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a17a237457e57625296e6b24feb19c60a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#a17a237457e57625296e6b24feb19c60a">Stop</a> ()</td></tr> +<tr class="memdesc:a17a237457e57625296e6b24feb19c60a"><td class="mdescLeft"> </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> +<tr class="separator:a17a237457e57625296e6b24feb19c60a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa75e3a38ab9fee7b2ad5522e746ad0af"><td class="memItemLeft" align="right" valign="top">const std::vector< <a class="el" href="structarmnn_1_1_measurement.xhtml">Measurement</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#aa75e3a38ab9fee7b2ad5522e746ad0af">GetMeasurements</a> () const</td></tr> +<tr class="memdesc:aa75e3a38ab9fee7b2ad5522e746ad0af"><td class="mdescLeft"> </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> +<tr class="separator:aa75e3a38ab9fee7b2ad5522e746ad0af"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a55466a39638bb671b24a82941aa37d77"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#a55466a39638bb671b24a82941aa37d77">GetName</a> () const</td></tr> +<tr class="memdesc:a55466a39638bb671b24a82941aa37d77"><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the event. <a href="#a55466a39638bb671b24a82941aa37d77">More...</a><br /></td></tr> +<tr class="separator:a55466a39638bb671b24a82941aa37d77"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a173e0f41677500fcbcf5b27a52d1caf2"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarmnn_1_1_profiler.xhtml">Profiler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#a173e0f41677500fcbcf5b27a52d1caf2">GetProfiler</a> () const</td></tr> +<tr class="memdesc:a173e0f41677500fcbcf5b27a52d1caf2"><td class="mdescLeft"> </td><td class="mdescRight">Get the pointer of the profiler associated with this event. <a href="#a173e0f41677500fcbcf5b27a52d1caf2">More...</a><br /></td></tr> +<tr class="separator:a173e0f41677500fcbcf5b27a52d1caf2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0ef4ff725b1ce859c6ef32e99e92dba3"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarmnn_1_1_event.xhtml">Event</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#a0ef4ff725b1ce859c6ef32e99e92dba3">GetParentEvent</a> () const</td></tr> +<tr class="memdesc:a0ef4ff725b1ce859c6ef32e99e92dba3"><td class="mdescLeft"> </td><td class="mdescRight">Get the pointer of the parent event. <a href="#a0ef4ff725b1ce859c6ef32e99e92dba3">More...</a><br /></td></tr> +<tr class="separator:a0ef4ff725b1ce859c6ef32e99e92dba3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa58c448afeade37f3b23f4842d46d9b5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1_backend_id.xhtml">BackendId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_event.xhtml#aa58c448afeade37f3b23f4842d46d9b5">GetBackendId</a> () const</td></tr> +<tr class="memdesc:aa58c448afeade37f3b23f4842d46d9b5"><td class="mdescLeft"> </td><td class="mdescRight">Get the backend id of the event. <a href="#aa58c448afeade37f3b23f4842d46d9b5">More...</a><br /></td></tr> +<tr class="separator:aa58c448afeade37f3b23f4842d46d9b5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab4b4d4f416d173cb297360ec636f72c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1_event.xhtml">Event</a> & </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> &other)=delete</td></tr> +<tr class="memdesc:ab4b4d4f416d173cb297360ec636f72c2"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#ab4b4d4f416d173cb297360ec636f72c2">More...</a><br /></td></tr> +<tr class="separator:ab4b4d4f416d173cb297360ec636f72c2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a776f936d6beb1089963c3ba7b0235c1e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1_event.xhtml">Event</a> & </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> &&other) noexcept</td></tr> +<tr class="memdesc:a776f936d6beb1089963c3ba7b0235c1e"><td class="mdescLeft"> </td><td class="mdescRight">Move Assignment operator. <a href="#a776f936d6beb1089963c3ba7b0235c1e">More...</a><br /></td></tr> +<tr class="separator:a776f936d6beb1089963c3ba7b0235c1e"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<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> + +<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> +</div><h2 class="groupheader">Member Typedef Documentation</h2> +<a id="a70926d23f3aef7e657a9057a7badb014"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a70926d23f3aef7e657a9057a7badb014">◆ </a></span>InstrumentPtr</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">using <a class="el" href="classarmnn_1_1_event.xhtml#a70926d23f3aef7e657a9057a7badb014">InstrumentPtr</a> = std::unique_ptr<<a class="el" href="classarmnn_1_1_instrument.xhtml">Instrument</a>></td> + </tr> + </table> +</div><div class="memdoc"> + +<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> + +</div> +</div> +<a id="a6e9642e693a4c5b8f1b8259844ef4feb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6e9642e693a4c5b8f1b8259844ef4feb">◆ </a></span>Instruments</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">using <a class="el" href="classarmnn_1_1_event.xhtml#a6e9642e693a4c5b8f1b8259844ef4feb">Instruments</a> = std::vector<<a class="el" href="classarmnn_1_1_event.xhtml#a70926d23f3aef7e657a9057a7badb014">InstrumentPtr</a>></td> + </tr> + </table> +</div><div class="memdoc"> + +<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> + +</div> +</div> +<h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a646c2ba712d97f26eb5b0e77e59d1722"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a646c2ba712d97f26eb5b0e77e59d1722">◆ </a></span>Event() <span class="overload">[1/3]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarmnn_1_1_event.xhtml">Event</a> </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>eventName</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classarmnn_1_1_profiler.xhtml">Profiler</a> * </td> + <td class="paramname"><em>profiler</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classarmnn_1_1_event.xhtml">Event</a> * </td> + <td class="paramname"><em>parent</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classarmnn_1_1_backend_id.xhtml">BackendId</a> </td> + <td class="paramname"><em>backendId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::vector< <a class="el" href="classarmnn_1_1_event.xhtml#a70926d23f3aef7e657a9057a7badb014">InstrumentPtr</a> > && </td> + <td class="paramname"><em>instrument</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<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> +<div class="fragment"><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  : m_EventName(eventName)</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  , m_Profiler(profiler)</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  , m_Parent(parent)</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  , m_BackendId(backendId)</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  , m_Instruments(std::move(instruments))</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> }</div></div><!-- fragment --> +</div> +</div> +<a id="a32713cc0b66b7e7e23def4eb53ae3795"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a32713cc0b66b7e7e23def4eb53ae3795">◆ </a></span>Event() <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_event.xhtml">Event</a> </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classarmnn_1_1_event.xhtml">Event</a> & </td> + <td class="paramname"><em>other</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">delete</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="adc2da08403f870c8a4022f308ec76c7b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#adc2da08403f870c8a4022f308ec76c7b">◆ </a></span>Event() <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_event.xhtml">Event</a> </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classarmnn_1_1_event.xhtml">Event</a> && </td> + <td class="paramname"><em>other</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">noexcept</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Move Constructor. </p> + +<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> +<div class="fragment"><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  : m_EventName(std::move(other.m_EventName))</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  , m_Profiler(other.m_Profiler)</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  , m_Parent(other.m_Parent)</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  , m_BackendId(other.m_BackendId)</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  , m_Instruments(std::move(other.m_Instruments))</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> }</div></div><!-- fragment --> +</div> +</div> +<a id="aed10f5e4b5520fcb155518eebd8993c4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aed10f5e4b5520fcb155518eebd8993c4">◆ </a></span>~Event()</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_event.xhtml">Event</a> </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">noexcept</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Destructor. </p> + +<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> +<div class="fragment"><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> }</div></div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="aa58c448afeade37f3b23f4842d46d9b5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa58c448afeade37f3b23f4842d46d9b5">◆ </a></span>GetBackendId()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarmnn_1_1_backend_id.xhtml">BackendId</a> GetBackendId </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the backend id of the event. </p> +<dl class="section return"><dt>Returns</dt><dd>Backend id of the event </dd></dl> + +<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> + +<p class="reference">Referenced by <a class="el" href="_profiling_8cpp_source.xhtml#l00115">Profiler::AnalyzeEventSequenceAndWriteResults()</a>.</p> +<div class="fragment"><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> {</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordflow">return</span> m_BackendId;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> }</div></div><!-- fragment --> +</div> +</div> +<a id="aa75e3a38ab9fee7b2ad5522e746ad0af"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa75e3a38ab9fee7b2ad5522e746ad0af">◆ </a></span>GetMeasurements()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const std::vector< <a class="el" href="structarmnn_1_1_measurement.xhtml">Measurement</a> > GetMeasurements </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +<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> +<dl class="section return"><dt>Returns</dt><dd>Recorded measurements of the event </dd></dl> + +<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> + +<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> +<div class="fragment"><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  std::vector<Measurement> measurements;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span>& instrument : m_Instruments)</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  {</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span>& measurement : instrument->GetMeasurements())</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  {</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  measurements.emplace_back(std::move(measurement));</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  }</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  }</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">return</span> measurements;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> }</div></div><!-- fragment --> +</div> +</div> +<a id="a55466a39638bb671b24a82941aa37d77"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a55466a39638bb671b24a82941aa37d77">◆ </a></span>GetName()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const std::string & GetName </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the name of the event. </p> +<dl class="section return"><dt>Returns</dt><dd>Name of the event </dd></dl> + +<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> + +<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> +<div class="fragment"><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> {</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordflow">return</span> m_EventName;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> }</div></div><!-- fragment --> +</div> +</div> +<a id="a0ef4ff725b1ce859c6ef32e99e92dba3"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a0ef4ff725b1ce859c6ef32e99e92dba3">◆ </a></span>GetParentEvent()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const <a class="el" href="classarmnn_1_1_event.xhtml">Event</a> * GetParentEvent </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the pointer of the parent event. </p> +<dl class="section return"><dt>Returns</dt><dd>Pointer of the parent event </dd></dl> + +<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> + +<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> +<div class="fragment"><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> {</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">return</span> m_Parent;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> }</div></div><!-- fragment --> +</div> +</div> +<a id="a173e0f41677500fcbcf5b27a52d1caf2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a173e0f41677500fcbcf5b27a52d1caf2">◆ </a></span>GetProfiler()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const <a class="el" href="classarmnn_1_1_profiler.xhtml">Profiler</a> * GetProfiler </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Get the pointer of the profiler associated with this event. </p> +<dl class="section return"><dt>Returns</dt><dd>Pointer of the profiler associated with this event </dd></dl> + +<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> +<div class="fragment"><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> {</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordflow">return</span> m_Profiler;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> }</div></div><!-- fragment --> +</div> +</div> +<a id="ab4b4d4f416d173cb297360ec636f72c2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab4b4d4f416d173cb297360ec636f72c2">◆ </a></span>operator=() <span class="overload">[1/2]</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_event.xhtml">Event</a>& operator= </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classarmnn_1_1_event.xhtml">Event</a> & </td> + <td class="paramname"><em>other</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">delete</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Assignment operator. </p> + +</div> +</div> +<a id="a776f936d6beb1089963c3ba7b0235c1e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a776f936d6beb1089963c3ba7b0235c1e">◆ </a></span>operator=() <span class="overload">[2/2]</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_event.xhtml">Event</a> & operator= </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classarmnn_1_1_event.xhtml">Event</a> && </td> + <td class="paramname"><em>other</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">noexcept</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Move Assignment operator. </p> + +<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> +<div class="fragment"><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> {</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">if</span> (<span class="keyword">this</span> == &other)</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  {</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  }</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  m_EventName = other.m_EventName;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  m_Profiler = other.m_Profiler;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  m_Parent = other.m_Parent;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  m_BackendId = other.m_BackendId;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  other.m_Profiler = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  other.m_Parent = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> }</div></div><!-- fragment --> +</div> +</div> +<a id="a07aaf1227e4d645f15e0a964f54ef291"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a07aaf1227e4d645f15e0a964f54ef291">◆ </a></span>Start()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void Start </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<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> + +<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> + +<p class="reference">Referenced by <a class="el" href="_profiling_event_test_8cpp_source.xhtml#l00017">BOOST_AUTO_TEST_CASE()</a>.</p> +<div class="fragment"><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span>& instrument : m_Instruments)</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  instrument->Start();</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  }</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> }</div></div><!-- fragment --> +</div> +</div> +<a id="a17a237457e57625296e6b24feb19c60a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a17a237457e57625296e6b24feb19c60a">◆ </a></span>Stop()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void Stop </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<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> + +<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> + +<p class="reference">Referenced by <a class="el" href="_profiling_event_test_8cpp_source.xhtml#l00017">BOOST_AUTO_TEST_CASE()</a>.</p> +<div class="fragment"><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> {</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span>& instrument : m_Instruments)</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  {</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  instrument->Stop();</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  }</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> }</div></div><!-- fragment --> +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>src/armnn/<a class="el" href="_profiling_event_8hpp_source.xhtml">ProfilingEvent.hpp</a></li> +<li>src/armnn/<a class="el" href="_profiling_event_8cpp_source.xhtml">ProfilingEvent.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.xhtml">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_event.xhtml">Event</a></li> + <li class="footer">Generated on Fri Mar 13 2020 16:09:17 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> |