Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 36eed46563a2a254e674865eb8ede62a1558c997 / . / Documentation / classarmnn_1_1profiling_1_1_profiling_connection_factory.xhtml
blob: ad9471e951ba0063145d05977b49da57683fcd93 [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: ProfilingConnectionFactory 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_1profiling_1_1_profiling_connection_factory.xhtml','');});
80</script>
81<div id="doc-content">
82<!-- window showing the filter options -->
83<div id="MSearchSelectWindow"
84 onmouseover="return searchBox.OnSearchSelectShow()"
85 onmouseout="return searchBox.OnSearchSelectHide()"
86 onkeydown="return searchBox.OnSearchSelectKey(event)">
87</div>
88
89<!-- iframe showing the search results (closed by default) -->
90<div id="MSearchResultsWindow">
91<iframe src="javascript:void(0)" frameborder="0"
92 name="MSearchResults" id="MSearchResults">
93</iframe>
94</div>
95
96<div class="header">
97 <div class="summary">
98<a href="#pub-methods">Public Member Functions</a> &#124;
99<a href="classarmnn_1_1profiling_1_1_profiling_connection_factory-members.xhtml">List of all members</a> </div>
100 <div class="headertitle">
101<div class="title">ProfilingConnectionFactory Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
102</div><!--header-->
103<div class="contents">
104
105<p><code>#include &lt;<a class="el" href="_profiling_connection_factory_8hpp_source.xhtml">ProfilingConnectionFactory.hpp</a>&gt;</code></p>
106<div class="dynheader">
107Inheritance diagram for ProfilingConnectionFactory:</div>
108<div class="dyncontent">
109 <div class="center">
110 <img src="classarmnn_1_1profiling_1_1_profiling_connection_factory.png" usemap="#ProfilingConnectionFactory_map" alt=""/>
111 <map id="ProfilingConnectionFactory_map" name="ProfilingConnectionFactory_map">
112<area href="classarmnn_1_1profiling_1_1_i_profiling_connection_factory.xhtml" alt="IProfilingConnectionFactory" shape="rect" coords="0,0,170,24"/>
113</map>
114 </div></div>
115<table class="memberdecls">
116<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
117Public Member Functions</h2></td></tr>
118<tr class="memitem:a021636a4ab3e8be192977226e1040fb5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_profiling_connection_factory.xhtml#a021636a4ab3e8be192977226e1040fb5">ProfilingConnectionFactory</a> ()=default</td></tr>
119<tr class="separator:a021636a4ab3e8be192977226e1040fb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
120<tr class="memitem:afa0882e4e30b0c255861f151a2538515"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_profiling_connection_factory.xhtml#afa0882e4e30b0c255861f151a2538515">~ProfilingConnectionFactory</a> ()=default</td></tr>
121<tr class="separator:afa0882e4e30b0c255861f151a2538515"><td class="memSeparator" colspan="2">&#160;</td></tr>
122<tr class="memitem:a627a4a9df4ecd888a1cf3380c5563d50"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection_factory.xhtml#abb7f442bd7409c8dff2b9346fd67bce3">IProfilingConnectionPtr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_profiling_connection_factory.xhtml#a627a4a9df4ecd888a1cf3380c5563d50">GetProfilingConnection</a> (const <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection_factory.xhtml#a1e3ab71aae7621abd6c1a16cc71b68e0">ExternalProfilingOptions</a> &amp;<a class="el" href="_file_only_profiling_decorator_tests_8cpp.xhtml#a6560146509197f3e197d8d36f76c1347">options</a>) const override</td></tr>
123<tr class="separator:a627a4a9df4ecd888a1cf3380c5563d50"><td class="memSeparator" colspan="2">&#160;</td></tr>
124<tr class="inherit_header pub_methods_classarmnn_1_1profiling_1_1_i_profiling_connection_factory"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarmnn_1_1profiling_1_1_i_profiling_connection_factory')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection_factory.xhtml">IProfilingConnectionFactory</a></td></tr>
125<tr class="memitem:a0edc1350a5dcc81620a1f28e2a1051f2 inherit pub_methods_classarmnn_1_1profiling_1_1_i_profiling_connection_factory"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection_factory.xhtml#a0edc1350a5dcc81620a1f28e2a1051f2">~IProfilingConnectionFactory</a> ()</td></tr>
126<tr class="separator:a0edc1350a5dcc81620a1f28e2a1051f2 inherit pub_methods_classarmnn_1_1profiling_1_1_i_profiling_connection_factory"><td class="memSeparator" colspan="2">&#160;</td></tr>
127</table><table class="memberdecls">
128<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
129Additional Inherited Members</h2></td></tr>
130<tr class="inherit_header pub_types_classarmnn_1_1profiling_1_1_i_profiling_connection_factory"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classarmnn_1_1profiling_1_1_i_profiling_connection_factory')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection_factory.xhtml">IProfilingConnectionFactory</a></td></tr>
131<tr class="memitem:a1e3ab71aae7621abd6c1a16cc71b68e0 inherit pub_types_classarmnn_1_1profiling_1_1_i_profiling_connection_factory"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection_factory.xhtml#a1e3ab71aae7621abd6c1a16cc71b68e0">ExternalProfilingOptions</a> = <a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml">IRuntime::CreationOptions::ExternalProfilingOptions</a></td></tr>
132<tr class="separator:a1e3ab71aae7621abd6c1a16cc71b68e0 inherit pub_types_classarmnn_1_1profiling_1_1_i_profiling_connection_factory"><td class="memSeparator" colspan="2">&#160;</td></tr>
133<tr class="memitem:abb7f442bd7409c8dff2b9346fd67bce3 inherit pub_types_classarmnn_1_1profiling_1_1_i_profiling_connection_factory"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection_factory.xhtml#abb7f442bd7409c8dff2b9346fd67bce3">IProfilingConnectionPtr</a> = std::unique_ptr&lt; <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.xhtml">IProfilingConnection</a> &gt;</td></tr>
134<tr class="separator:abb7f442bd7409c8dff2b9346fd67bce3 inherit pub_types_classarmnn_1_1profiling_1_1_i_profiling_connection_factory"><td class="memSeparator" colspan="2">&#160;</td></tr>
135</table>
136<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
137<div class="textblock">
138<p class="definition">Definition at line <a class="el" href="_profiling_connection_factory_8hpp_source.xhtml#l00016">16</a> of file <a class="el" href="_profiling_connection_factory_8hpp_source.xhtml">ProfilingConnectionFactory.hpp</a>.</p>
139</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
140<a id="a021636a4ab3e8be192977226e1040fb5"></a>
141<h2 class="memtitle"><span class="permalink"><a href="#a021636a4ab3e8be192977226e1040fb5">&#9670;&nbsp;</a></span>ProfilingConnectionFactory()</h2>
142
143<div class="memitem">
144<div class="memproto">
145<table class="mlabels">
146 <tr>
147 <td class="mlabels-left">
148 <table class="memname">
149 <tr>
150 <td class="memname"><a class="el" href="classarmnn_1_1profiling_1_1_profiling_connection_factory.xhtml">ProfilingConnectionFactory</a> </td>
151 <td>(</td>
152 <td class="paramname"></td><td>)</td>
153 <td></td>
154 </tr>
155 </table>
156 </td>
157 <td class="mlabels-right">
158<span class="mlabels"><span class="mlabel">default</span></span> </td>
159 </tr>
160</table>
161</div><div class="memdoc">
162
163</div>
164</div>
165<a id="afa0882e4e30b0c255861f151a2538515"></a>
166<h2 class="memtitle"><span class="permalink"><a href="#afa0882e4e30b0c255861f151a2538515">&#9670;&nbsp;</a></span>~ProfilingConnectionFactory()</h2>
167
168<div class="memitem">
169<div class="memproto">
170<table class="mlabels">
171 <tr>
172 <td class="mlabels-left">
173 <table class="memname">
174 <tr>
175 <td class="memname">~<a class="el" href="classarmnn_1_1profiling_1_1_profiling_connection_factory.xhtml">ProfilingConnectionFactory</a> </td>
176 <td>(</td>
177 <td class="paramname"></td><td>)</td>
178 <td></td>
179 </tr>
180 </table>
181 </td>
182 <td class="mlabels-right">
183<span class="mlabels"><span class="mlabel">default</span></span> </td>
184 </tr>
185</table>
186</div><div class="memdoc">
187
188</div>
189</div>
190<h2 class="groupheader">Member Function Documentation</h2>
191<a id="a627a4a9df4ecd888a1cf3380c5563d50"></a>
192<h2 class="memtitle"><span class="permalink"><a href="#a627a4a9df4ecd888a1cf3380c5563d50">&#9670;&nbsp;</a></span>GetProfilingConnection()</h2>
193
194<div class="memitem">
195<div class="memproto">
196<table class="mlabels">
197 <tr>
198 <td class="mlabels-left">
199 <table class="memname">
200 <tr>
201 <td class="memname">std::unique_ptr&lt; <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.xhtml">IProfilingConnection</a> &gt; GetProfilingConnection </td>
202 <td>(</td>
203 <td class="paramtype">const <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection_factory.xhtml#a1e3ab71aae7621abd6c1a16cc71b68e0">ExternalProfilingOptions</a> &amp;&#160;</td>
204 <td class="paramname"><em>options</em></td><td>)</td>
205 <td> const</td>
206 </tr>
207 </table>
208 </td>
209 <td class="mlabels-right">
210<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
211 </tr>
212</table>
213</div><div class="memdoc">
214
215<p>Implements <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection_factory.xhtml#a18f247c2a53095da228e441270536b03">IProfilingConnectionFactory</a>.</p>
216
217<p class="definition">Definition at line <a class="el" href="_profiling_connection_factory_8cpp_source.xhtml#l00018">18</a> of file <a class="el" href="_profiling_connection_factory_8cpp_source.xhtml">ProfilingConnectionFactory.cpp</a>.</p>
218
219<p class="reference">References <a class="el" href="_file_only_profiling_decorator_tests_8cpp_source.xhtml#l00045">options</a>.</p>
220<div class="fragment"><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;{</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="comment">// We can create 3 different types of IProfilingConnection.</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="comment">// 1: If no relevant options are specified then a SocketProfilingConnection is returned.</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="comment">// 2: If both incoming and outgoing capture files are specified then a SocketProfilingConnection decorated by a</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="comment">// ProfilingConnectionDumpToFileDecorator is returned.</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="comment">// 3: If both incoming and outgoing capture files are specified and &quot;file only&quot; then a FileOnlyProfilingConnection</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="comment">// decorated by a ProfilingConnectionDumpToFileDecorator is returned.</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordflow">if</span> ((!<a class="code" href="_file_only_profiling_decorator_tests_8cpp.xhtml#a6560146509197f3e197d8d36f76c1347">options</a>.m_IncomingCaptureFile.empty() || !<a class="code" href="_file_only_profiling_decorator_tests_8cpp.xhtml#a6560146509197f3e197d8d36f76c1347">options</a>.m_OutgoingCaptureFile.empty()) &amp;&amp; !<a class="code" href="_file_only_profiling_decorator_tests_8cpp.xhtml#a6560146509197f3e197d8d36f76c1347">options</a>.m_FileOnly)</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="comment">// This is type 2.</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordflow">return</span> std::make_unique&lt;ProfilingConnectionDumpToFileDecorator&gt;(std::make_unique&lt;SocketProfilingConnection&gt;(),</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <a class="code" href="_file_only_profiling_decorator_tests_8cpp.xhtml#a6560146509197f3e197d8d36f76c1347">options</a>);</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; }</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordflow">else</span> <span class="keywordflow">if</span> ((!<a class="code" href="_file_only_profiling_decorator_tests_8cpp.xhtml#a6560146509197f3e197d8d36f76c1347">options</a>.m_IncomingCaptureFile.empty() || !<a class="code" href="_file_only_profiling_decorator_tests_8cpp.xhtml#a6560146509197f3e197d8d36f76c1347">options</a>.m_OutgoingCaptureFile.empty()) &amp;&amp; <a class="code" href="_file_only_profiling_decorator_tests_8cpp.xhtml#a6560146509197f3e197d8d36f76c1347">options</a>.m_FileOnly)</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="comment">// This is type 3.</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordflow">return</span> std::make_unique&lt;ProfilingConnectionDumpToFileDecorator&gt;(</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; std::make_unique&lt;FileOnlyProfilingConnection&gt;(<a class="code" href="_file_only_profiling_decorator_tests_8cpp.xhtml#a6560146509197f3e197d8d36f76c1347">options</a>), <a class="code" href="_file_only_profiling_decorator_tests_8cpp.xhtml#a6560146509197f3e197d8d36f76c1347">options</a>);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; }</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordflow">else</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="comment">// This is type 1.</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordflow">return</span> std::make_unique&lt;SocketProfilingConnection&gt;();</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 class="ttc" id="_file_only_profiling_decorator_tests_8cpp_xhtml_a6560146509197f3e197d8d36f76c1347"><div class="ttname"><a href="_file_only_profiling_decorator_tests_8cpp.xhtml#a6560146509197f3e197d8d36f76c1347">options</a></div><div class="ttdeci">armnn::Runtime::CreationOptions::ExternalProfilingOptions options</div><div class="ttdef"><b>Definition:</b> <a href="_file_only_profiling_decorator_tests_8cpp_source.xhtml#l00045">FileOnlyProfilingDecoratorTests.cpp:45</a></div></div>
221</div><!-- fragment -->
222</div>
223</div>
224<hr/>The documentation for this class was generated from the following files:<ul>
225<li>src/profiling/<a class="el" href="_profiling_connection_factory_8hpp_source.xhtml">ProfilingConnectionFactory.hpp</a></li>
226<li>src/profiling/<a class="el" href="_profiling_connection_factory_8cpp_source.xhtml">ProfilingConnectionFactory.cpp</a></li>
227</ul>
228</div><!-- contents -->
229</div><!-- doc-content -->
230<!-- start footer part -->
231<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
232 <ul>
233 <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="namespacearmnn_1_1profiling.xhtml">profiling</a></li><li class="navelem"><a class="el" href="classarmnn_1_1profiling_1_1_profiling_connection_factory.xhtml">ProfilingConnectionFactory</a></li>
234 <li class="footer">Generated on Fri Mar 13 2020 16:09:21 for ArmNN by
235 <a href="http://www.doxygen.org/index.html">
236 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
237 </ul>
238</div>
239</body>
240</html>