Ryan OShea | de36e4a | 2020-03-13 16:26:19 +0000 | [diff] [blame^] | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 2 | <html xmlns="http://www.w3.org/1999/xhtml"> |
| 3 | <head> |
| 4 | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 5 | <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| 6 | <meta name="generator" content="Doxygen 1.8.13"/> |
| 7 | <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| 8 | <title>ArmNN: ProfilingConnectionFactory Class Reference</title> |
| 9 | <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| 10 | <script type="text/javascript" src="jquery.js"></script> |
| 11 | <script type="text/javascript" src="dynsections.js"></script> |
| 12 | <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| 13 | <script type="text/javascript" src="resize.js"></script> |
| 14 | <script type="text/javascript" src="navtreedata.js"></script> |
| 15 | <script type="text/javascript" src="navtree.js"></script> |
| 16 | <script type="text/javascript"> |
| 17 | $(document).ready(initResizable); |
| 18 | </script> |
| 19 | <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| 20 | <script type="text/javascript" src="search/searchdata.js"></script> |
| 21 | <script type="text/javascript" src="search/search.js"></script> |
| 22 | <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| 23 | </head> |
| 24 | <body> |
| 25 | <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 26 | <div id="titlearea"> |
| 27 | <table cellspacing="0" cellpadding="0"> |
| 28 | <tbody> |
| 29 | <tr style="height: 56px;"> |
| 30 | <td id="projectalign" style="padding-left: 0.5em;"> |
| 31 | <div id="projectname">ArmNN |
| 32 |  <span id="projectnumber">NotReleased</span> |
| 33 | </div> |
| 34 | </td> |
| 35 | </tr> |
| 36 | </tbody> |
| 37 | </table> |
| 38 | </div> |
| 39 | <!-- end header part --> |
| 40 | <!-- Generated by Doxygen 1.8.13 --> |
| 41 | <script type="text/javascript"> |
| 42 | var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| 43 | </script> |
| 44 | <script type="text/javascript" src="menudata.js"></script> |
| 45 | <script type="text/javascript" src="menu.js"></script> |
| 46 | <script type="text/javascript"> |
| 47 | $(function() { |
| 48 | initMenu('',true,false,'search.php','Search'); |
| 49 | $(document).ready(function() { init_search(); }); |
| 50 | }); |
| 51 | </script> |
| 52 | <div id="main-nav"></div> |
| 53 | </div><!-- top --> |
| 54 | <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| 55 | <div id="nav-tree"> |
| 56 | <div id="nav-tree-contents"> |
| 57 | <div id="nav-sync" class="sync"></div> |
| 58 | </div> |
| 59 | </div> |
| 60 | <div id="splitbar" style="-moz-user-select:none;" |
| 61 | class="ui-resizable-handle"> |
| 62 | </div> |
| 63 | </div> |
| 64 | <script type="text/javascript"> |
| 65 | $(document).ready(function(){initNavTree('classarmnn_1_1profiling_1_1_profiling_connection_factory.html','');}); |
| 66 | </script> |
| 67 | <div id="doc-content"> |
| 68 | <!-- window showing the filter options --> |
| 69 | <div id="MSearchSelectWindow" |
| 70 | onmouseover="return searchBox.OnSearchSelectShow()" |
| 71 | onmouseout="return searchBox.OnSearchSelectHide()" |
| 72 | onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| 73 | </div> |
| 74 | |
| 75 | <!-- iframe showing the search results (closed by default) --> |
| 76 | <div id="MSearchResultsWindow"> |
| 77 | <iframe src="javascript:void(0)" frameborder="0" |
| 78 | name="MSearchResults" id="MSearchResults"> |
| 79 | </iframe> |
| 80 | </div> |
| 81 | |
| 82 | <div class="header"> |
| 83 | <div class="summary"> |
| 84 | <a href="#pub-methods">Public Member Functions</a> | |
| 85 | <a href="classarmnn_1_1profiling_1_1_profiling_connection_factory-members.html">List of all members</a> </div> |
| 86 | <div class="headertitle"> |
| 87 | <div class="title">ProfilingConnectionFactory Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div> |
| 88 | </div><!--header--> |
| 89 | <div class="contents"> |
| 90 | |
| 91 | <p><code>#include <<a class="el" href="_profiling_connection_factory_8hpp_source.html">ProfilingConnectionFactory.hpp</a>></code></p> |
| 92 | <div class="dynheader"> |
| 93 | Inheritance diagram for ProfilingConnectionFactory:</div> |
| 94 | <div class="dyncontent"> |
| 95 | <div class="center"> |
| 96 | <img src="classarmnn_1_1profiling_1_1_profiling_connection_factory.png" usemap="#ProfilingConnectionFactory_map" alt=""/> |
| 97 | <map id="ProfilingConnectionFactory_map" name="ProfilingConnectionFactory_map"> |
| 98 | <area href="classarmnn_1_1profiling_1_1_i_profiling_connection_factory.html" alt="IProfilingConnectionFactory" shape="rect" coords="0,0,170,24"/> |
| 99 | </map> |
| 100 | </div></div> |
| 101 | <table class="memberdecls"> |
| 102 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| 103 | Public Member Functions</h2></td></tr> |
| 104 | <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.html#a021636a4ab3e8be192977226e1040fb5">ProfilingConnectionFactory</a> ()=default</td></tr> |
| 105 | <tr class="separator:a021636a4ab3e8be192977226e1040fb5"><td class="memSeparator" colspan="2"> </td></tr> |
| 106 | <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.html#afa0882e4e30b0c255861f151a2538515">~ProfilingConnectionFactory</a> ()=default</td></tr> |
| 107 | <tr class="separator:afa0882e4e30b0c255861f151a2538515"><td class="memSeparator" colspan="2"> </td></tr> |
| 108 | <tr class="memitem:a627a4a9df4ecd888a1cf3380c5563d50"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection_factory.html#abb7f442bd7409c8dff2b9346fd67bce3">IProfilingConnectionPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_profiling_connection_factory.html#a627a4a9df4ecd888a1cf3380c5563d50">GetProfilingConnection</a> (const <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection_factory.html#a1e3ab71aae7621abd6c1a16cc71b68e0">ExternalProfilingOptions</a> &<a class="el" href="_file_only_profiling_decorator_tests_8cpp.html#a6560146509197f3e197d8d36f76c1347">options</a>) const override</td></tr> |
| 109 | <tr class="separator:a627a4a9df4ecd888a1cf3380c5563d50"><td class="memSeparator" colspan="2"> </td></tr> |
| 110 | <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.html">IProfilingConnectionFactory</a></td></tr> |
| 111 | <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.html#a0edc1350a5dcc81620a1f28e2a1051f2">~IProfilingConnectionFactory</a> ()</td></tr> |
| 112 | <tr class="separator:a0edc1350a5dcc81620a1f28e2a1051f2 inherit pub_methods_classarmnn_1_1profiling_1_1_i_profiling_connection_factory"><td class="memSeparator" colspan="2"> </td></tr> |
| 113 | </table><table class="memberdecls"> |
| 114 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> |
| 115 | Additional Inherited Members</h2></td></tr> |
| 116 | <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.html">IProfilingConnectionFactory</a></td></tr> |
| 117 | <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.html#a1e3ab71aae7621abd6c1a16cc71b68e0">ExternalProfilingOptions</a> = <a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.html">IRuntime::CreationOptions::ExternalProfilingOptions</a></td></tr> |
| 118 | <tr class="separator:a1e3ab71aae7621abd6c1a16cc71b68e0 inherit pub_types_classarmnn_1_1profiling_1_1_i_profiling_connection_factory"><td class="memSeparator" colspan="2"> </td></tr> |
| 119 | <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.html#abb7f442bd7409c8dff2b9346fd67bce3">IProfilingConnectionPtr</a> = std::unique_ptr< <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.html">IProfilingConnection</a> ></td></tr> |
| 120 | <tr class="separator:abb7f442bd7409c8dff2b9346fd67bce3 inherit pub_types_classarmnn_1_1profiling_1_1_i_profiling_connection_factory"><td class="memSeparator" colspan="2"> </td></tr> |
| 121 | </table> |
| 122 | <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| 123 | <div class="textblock"> |
| 124 | <p class="definition">Definition at line <a class="el" href="_profiling_connection_factory_8hpp_source.html#l00016">16</a> of file <a class="el" href="_profiling_connection_factory_8hpp_source.html">ProfilingConnectionFactory.hpp</a>.</p> |
| 125 | </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| 126 | <a id="a021636a4ab3e8be192977226e1040fb5"></a> |
| 127 | <h2 class="memtitle"><span class="permalink"><a href="#a021636a4ab3e8be192977226e1040fb5">◆ </a></span>ProfilingConnectionFactory()</h2> |
| 128 | |
| 129 | <div class="memitem"> |
| 130 | <div class="memproto"> |
| 131 | <table class="mlabels"> |
| 132 | <tr> |
| 133 | <td class="mlabels-left"> |
| 134 | <table class="memname"> |
| 135 | <tr> |
| 136 | <td class="memname"><a class="el" href="classarmnn_1_1profiling_1_1_profiling_connection_factory.html">ProfilingConnectionFactory</a> </td> |
| 137 | <td>(</td> |
| 138 | <td class="paramname"></td><td>)</td> |
| 139 | <td></td> |
| 140 | </tr> |
| 141 | </table> |
| 142 | </td> |
| 143 | <td class="mlabels-right"> |
| 144 | <span class="mlabels"><span class="mlabel">default</span></span> </td> |
| 145 | </tr> |
| 146 | </table> |
| 147 | </div><div class="memdoc"> |
| 148 | |
| 149 | </div> |
| 150 | </div> |
| 151 | <a id="afa0882e4e30b0c255861f151a2538515"></a> |
| 152 | <h2 class="memtitle"><span class="permalink"><a href="#afa0882e4e30b0c255861f151a2538515">◆ </a></span>~ProfilingConnectionFactory()</h2> |
| 153 | |
| 154 | <div class="memitem"> |
| 155 | <div class="memproto"> |
| 156 | <table class="mlabels"> |
| 157 | <tr> |
| 158 | <td class="mlabels-left"> |
| 159 | <table class="memname"> |
| 160 | <tr> |
| 161 | <td class="memname">~<a class="el" href="classarmnn_1_1profiling_1_1_profiling_connection_factory.html">ProfilingConnectionFactory</a> </td> |
| 162 | <td>(</td> |
| 163 | <td class="paramname"></td><td>)</td> |
| 164 | <td></td> |
| 165 | </tr> |
| 166 | </table> |
| 167 | </td> |
| 168 | <td class="mlabels-right"> |
| 169 | <span class="mlabels"><span class="mlabel">default</span></span> </td> |
| 170 | </tr> |
| 171 | </table> |
| 172 | </div><div class="memdoc"> |
| 173 | |
| 174 | </div> |
| 175 | </div> |
| 176 | <h2 class="groupheader">Member Function Documentation</h2> |
| 177 | <a id="a627a4a9df4ecd888a1cf3380c5563d50"></a> |
| 178 | <h2 class="memtitle"><span class="permalink"><a href="#a627a4a9df4ecd888a1cf3380c5563d50">◆ </a></span>GetProfilingConnection()</h2> |
| 179 | |
| 180 | <div class="memitem"> |
| 181 | <div class="memproto"> |
| 182 | <table class="mlabels"> |
| 183 | <tr> |
| 184 | <td class="mlabels-left"> |
| 185 | <table class="memname"> |
| 186 | <tr> |
| 187 | <td class="memname">std::unique_ptr< <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection.html">IProfilingConnection</a> > GetProfilingConnection </td> |
| 188 | <td>(</td> |
| 189 | <td class="paramtype">const <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection_factory.html#a1e3ab71aae7621abd6c1a16cc71b68e0">ExternalProfilingOptions</a> & </td> |
| 190 | <td class="paramname"><em>options</em></td><td>)</td> |
| 191 | <td> const</td> |
| 192 | </tr> |
| 193 | </table> |
| 194 | </td> |
| 195 | <td class="mlabels-right"> |
| 196 | <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| 197 | </tr> |
| 198 | </table> |
| 199 | </div><div class="memdoc"> |
| 200 | |
| 201 | <p>Implements <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_connection_factory.html#a18f247c2a53095da228e441270536b03">IProfilingConnectionFactory</a>.</p> |
| 202 | |
| 203 | <p class="definition">Definition at line <a class="el" href="_profiling_connection_factory_8cpp_source.html#l00018">18</a> of file <a class="el" href="_profiling_connection_factory_8cpp_source.html">ProfilingConnectionFactory.cpp</a>.</p> |
| 204 | |
| 205 | <p class="reference">References <a class="el" href="_file_only_profiling_decorator_tests_8cpp_source.html#l00045">options</a>.</p> |
| 206 | <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.html#a6560146509197f3e197d8d36f76c1347">options</a>.m_IncomingCaptureFile.empty() || !<a class="code" href="_file_only_profiling_decorator_tests_8cpp.html#a6560146509197f3e197d8d36f76c1347">options</a>.m_OutgoingCaptureFile.empty()) && !<a class="code" href="_file_only_profiling_decorator_tests_8cpp.html#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.html#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.html#a6560146509197f3e197d8d36f76c1347">options</a>.m_IncomingCaptureFile.empty() || !<a class="code" href="_file_only_profiling_decorator_tests_8cpp.html#a6560146509197f3e197d8d36f76c1347">options</a>.m_OutgoingCaptureFile.empty()) && <a class="code" href="_file_only_profiling_decorator_tests_8cpp.html#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.html#a6560146509197f3e197d8d36f76c1347">options</a>), <a class="code" href="_file_only_profiling_decorator_tests_8cpp.html#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_html_a6560146509197f3e197d8d36f76c1347"><div class="ttname"><a href="_file_only_profiling_decorator_tests_8cpp.html#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.html#l00045">FileOnlyProfilingDecoratorTests.cpp:45</a></div></div> |
| 207 | </div><!-- fragment --> |
| 208 | </div> |
| 209 | </div> |
| 210 | <hr/>The documentation for this class was generated from the following files:<ul> |
| 211 | <li>src/profiling/<a class="el" href="_profiling_connection_factory_8hpp_source.html">ProfilingConnectionFactory.hpp</a></li> |
| 212 | <li>src/profiling/<a class="el" href="_profiling_connection_factory_8cpp_source.html">ProfilingConnectionFactory.cpp</a></li> |
| 213 | </ul> |
| 214 | </div><!-- contents --> |
| 215 | </div><!-- doc-content --> |
| 216 | <!-- start footer part --> |
| 217 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| 218 | <ul> |
| 219 | <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="namespacearmnn_1_1profiling.html">profiling</a></li><li class="navelem"><a class="el" href="classarmnn_1_1profiling_1_1_profiling_connection_factory.html">ProfilingConnectionFactory</a></li> |
| 220 | <li class="footer">Generated on Fri Mar 13 2020 16:07:06 for ArmNN by |
| 221 | <a href="http://www.doxygen.org/index.html"> |
| 222 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> |
| 223 | </ul> |
| 224 | </div> |
| 225 | </body> |
| 226 | </html> |