| <!-- 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: ProfilingConnectionFactory 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_1profiling_1_1_profiling_connection_factory.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-methods">Public Member Functions</a> | |
| <a href="classarmnn_1_1profiling_1_1_profiling_connection_factory-members.xhtml">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">ProfilingConnectionFactory Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><code>#include <<a class="el" href="_profiling_connection_factory_8hpp_source.xhtml">ProfilingConnectionFactory.hpp</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for ProfilingConnectionFactory:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classarmnn_1_1profiling_1_1_profiling_connection_factory.png" usemap="#ProfilingConnectionFactory_map" alt=""/> |
| <map id="ProfilingConnectionFactory_map" name="ProfilingConnectionFactory_map"> |
| <area href="classarmnn_1_1profiling_1_1_i_profiling_connection_factory.xhtml" alt="IProfilingConnectionFactory" shape="rect" coords="0,0,170,24"/> |
| </map> |
| </div></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a021636a4ab3e8be192977226e1040fb5"><td class="memItemLeft" align="right" valign="top"> </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> |
| <tr class="separator:a021636a4ab3e8be192977226e1040fb5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afa0882e4e30b0c255861f151a2538515"><td class="memItemLeft" align="right" valign="top"> </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> |
| <tr class="separator:afa0882e4e30b0c255861f151a2538515"><td class="memSeparator" colspan="2"> </td></tr> |
| <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> </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> &<a class="el" href="_file_only_profiling_decorator_tests_8cpp.xhtml#a6560146509197f3e197d8d36f76c1347">options</a>) const override</td></tr> |
| <tr class="separator:a627a4a9df4ecd888a1cf3380c5563d50"><td class="memSeparator" colspan="2"> </td></tr> |
| <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="-"/> Public Member Functions inherited from <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection_factory.xhtml">IProfilingConnectionFactory</a></td></tr> |
| <tr class="memitem:a0edc1350a5dcc81620a1f28e2a1051f2 inherit pub_methods_classarmnn_1_1profiling_1_1_i_profiling_connection_factory"><td class="memItemLeft" align="right" valign="top">virtual </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> |
| <tr class="separator:a0edc1350a5dcc81620a1f28e2a1051f2 inherit pub_methods_classarmnn_1_1profiling_1_1_i_profiling_connection_factory"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> |
| Additional Inherited Members</h2></td></tr> |
| <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="-"/> Public Types inherited from <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection_factory.xhtml">IProfilingConnectionFactory</a></td></tr> |
| <tr class="memitem:a1e3ab71aae7621abd6c1a16cc71b68e0 inherit pub_types_classarmnn_1_1profiling_1_1_i_profiling_connection_factory"><td class="memItemLeft" align="right" valign="top">using </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> |
| <tr class="separator:a1e3ab71aae7621abd6c1a16cc71b68e0 inherit pub_types_classarmnn_1_1profiling_1_1_i_profiling_connection_factory"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abb7f442bd7409c8dff2b9346fd67bce3 inherit pub_types_classarmnn_1_1profiling_1_1_i_profiling_connection_factory"><td class="memItemLeft" align="right" valign="top">using </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< <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.xhtml">IProfilingConnection</a> ></td></tr> |
| <tr class="separator:abb7f442bd7409c8dff2b9346fd67bce3 inherit pub_types_classarmnn_1_1profiling_1_1_i_profiling_connection_factory"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"> |
| <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> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a021636a4ab3e8be192977226e1040fb5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a021636a4ab3e8be192977226e1040fb5">◆ </a></span>ProfilingConnectionFactory()</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_1profiling_1_1_profiling_connection_factory.xhtml">ProfilingConnectionFactory</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">default</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="afa0882e4e30b0c255861f151a2538515"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afa0882e4e30b0c255861f151a2538515">◆ </a></span>~ProfilingConnectionFactory()</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_1profiling_1_1_profiling_connection_factory.xhtml">ProfilingConnectionFactory</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">default</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a627a4a9df4ecd888a1cf3380c5563d50"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a627a4a9df4ecd888a1cf3380c5563d50">◆ </a></span>GetProfilingConnection()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::unique_ptr< <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.xhtml">IProfilingConnection</a> > GetProfilingConnection </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection_factory.xhtml#a1e3ab71aae7621abd6c1a16cc71b68e0">ExternalProfilingOptions</a> & </td> |
| <td class="paramname"><em>options</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Implements <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection_factory.xhtml#a18f247c2a53095da228e441270536b03">IProfilingConnectionFactory</a>.</p> |
| |
| <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> |
| |
| <p class="reference">References <a class="el" href="_file_only_profiling_decorator_tests_8cpp_source.xhtml#l00045">options</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <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>  <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>  <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>  <span class="comment">// ProfilingConnectionDumpToFileDecorator is returned.</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="comment">// 3: If both incoming and outgoing capture files are specified and "file only" then a FileOnlyProfilingConnection</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="comment">// decorated by a ProfilingConnectionDumpToFileDecorator is returned.</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</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()) && !<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>  {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="comment">// This is type 2.</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordflow">return</span> std::make_unique<ProfilingConnectionDumpToFileDecorator>(std::make_unique<SocketProfilingConnection>(),</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <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>  }</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <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()) && <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>  {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="comment">// This is type 3.</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordflow">return</span> std::make_unique<ProfilingConnectionDumpToFileDecorator>(</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  std::make_unique<FileOnlyProfilingConnection>(<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>  }</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// This is type 1.</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordflow">return</span> std::make_unique<SocketProfilingConnection>();</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 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> |
| </div><!-- fragment --> |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>src/profiling/<a class="el" href="_profiling_connection_factory_8hpp_source.xhtml">ProfilingConnectionFactory.hpp</a></li> |
| <li>src/profiling/<a class="el" href="_profiling_connection_factory_8cpp_source.xhtml">ProfilingConnectionFactory.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="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> |
| <li class="footer">Generated on Fri Mar 13 2020 16:09:21 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> |
