Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / e09fc820968ee4de20df60e371088582a710bad0 / . / Documentation / classarmnn_1_1_dot_node.xhtml
blob: 584b8cd411fe3e3850c4f33c299f4caf2e577809 [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: DotNode Class Reference</title>
15<link href="tabs.css" rel="stylesheet" type="text/css"/>
16<script type="text/javascript" src="jquery.js"></script>
17<script type="text/javascript" src="dynsections.js"></script>
18<link href="navtree.css" rel="stylesheet" type="text/css"/>
19<script type="text/javascript" src="resize.js"></script>
20<script type="text/javascript" src="navtreedata.js"></script>
21<script type="text/javascript" src="navtree.js"></script>
22<script type="text/javascript">
23 $(document).ready(initResizable);
24</script>
25<link href="search/search.css" rel="stylesheet" type="text/css"/>
26<script type="text/javascript" src="search/searchdata.js"></script>
27<script type="text/javascript" src="search/search.js"></script>
28<script type="text/x-mathjax-config">
29 MathJax.Hub.Config({
30 extensions: ["tex2jax.js"],
31 jax: ["input/TeX","output/HTML-CSS"],
32});
33</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
34<link href="doxygen.css" rel="stylesheet" type="text/css" />
35<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
36</head>
37<body>
38<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
39<div id="titlearea">
40<table cellspacing="0" cellpadding="0">
41 <tbody>
42 <tr style="height: 56px;">
43 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
44 <td style="padding-left: 0.5em;">
45 <div id="projectname">
46 &#160;<span id="projectnumber">20.02</span>
47 </div>
48 </td>
49 </tr>
50 </tbody>
51</table>
52</div>
53<!-- end header part -->
54<!-- Generated by Doxygen 1.8.13 -->
55<script type="text/javascript">
56var searchBox = new SearchBox("searchBox", "search",false,'Search');
57</script>
58<script type="text/javascript" src="menudata.js"></script>
59<script type="text/javascript" src="menu.js"></script>
60<script type="text/javascript">
61$(function() {
62 initMenu('',true,false,'search.php','Search');
63 $(document).ready(function() { init_search(); });
64});
65</script>
66<div id="main-nav"></div>
67</div><!-- top -->
68<div id="side-nav" class="ui-resizable side-nav-resizable">
69 <div id="nav-tree">
70 <div id="nav-tree-contents">
71 <div id="nav-sync" class="sync"></div>
72 </div>
73 </div>
74 <div id="splitbar" style="-moz-user-select:none;"
75 class="ui-resizable-handle">
76 </div>
77</div>
78<script type="text/javascript">
79$(document).ready(function(){initNavTree('classarmnn_1_1_dot_node.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_1_dot_node-members.xhtml">List of all members</a> </div>
100 <div class="headertitle">
101<div class="title">DotNode Class Reference</div> </div>
102</div><!--header-->
103<div class="contents">
104
105<p><code>#include &lt;<a class="el" href="_dot_serializer_8hpp_source.xhtml">DotSerializer.hpp</a>&gt;</code></p>
106<div class="dynheader">
107Inheritance diagram for DotNode:</div>
108<div class="dyncontent">
109 <div class="center">
110 <img src="classarmnn_1_1_dot_node.png" usemap="#DotNode_map" alt=""/>
111 <map id="DotNode_map" name="DotNode_map">
112<area href="classarmnn_1_1_dot_base.xhtml" alt="DotBase" shape="rect" coords="0,0,61,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:a8ba78d7bbd1838e28d4208c3a1f2110d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_dot_node.xhtml#a8ba78d7bbd1838e28d4208c3a1f2110d">DotNode</a> (std::ostream &amp;stream, <a class="el" href="namespacearmnn.xhtml#afad4088a9a058114ee5f87246f87bf49">LayerGuid</a> nodeId, const char *label)</td></tr>
119<tr class="separator:a8ba78d7bbd1838e28d4208c3a1f2110d"><td class="memSeparator" colspan="2">&#160;</td></tr>
120<tr class="memitem:a1a90b7c27390c5b4f7828a0c9917f6fe"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_dot_node.xhtml#a1a90b7c27390c5b4f7828a0c9917f6fe">~DotNode</a> ()</td></tr>
121<tr class="separator:a1a90b7c27390c5b4f7828a0c9917f6fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
122<tr class="memitem:a1734bc659f144a8465e22d4b53b8f580"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1_node_content.xhtml">NodeContent</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_dot_node.xhtml#a1734bc659f144a8465e22d4b53b8f580">GetContents</a> ()</td></tr>
123<tr class="separator:a1734bc659f144a8465e22d4b53b8f580"><td class="memSeparator" colspan="2">&#160;</td></tr>
124<tr class="memitem:a721c9bf7f2e6a2d88d340253ccc19815"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1_dot_attribute_set.xhtml">DotAttributeSet</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_dot_node.xhtml#a721c9bf7f2e6a2d88d340253ccc19815">GetAttributeSet</a> ()</td></tr>
125<tr class="separator:a721c9bf7f2e6a2d88d340253ccc19815"><td class="memSeparator" colspan="2">&#160;</td></tr>
126<tr class="inherit_header pub_methods_classarmnn_1_1_dot_base"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarmnn_1_1_dot_base')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarmnn_1_1_dot_base.xhtml">DotBase</a></td></tr>
127<tr class="memitem:afba1dd3b85fb26c87e892ed80452d116 inherit pub_methods_classarmnn_1_1_dot_base"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_dot_base.xhtml#afba1dd3b85fb26c87e892ed80452d116">DotBase</a> (std::ostream &amp;stream)</td></tr>
128<tr class="separator:afba1dd3b85fb26c87e892ed80452d116 inherit pub_methods_classarmnn_1_1_dot_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
129<tr class="memitem:a99131c6a3da28cceeeb67d732ff39d7d inherit pub_methods_classarmnn_1_1_dot_base"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_dot_base.xhtml#a99131c6a3da28cceeeb67d732ff39d7d">GetStream</a> ()</td></tr>
130<tr class="separator:a99131c6a3da28cceeeb67d732ff39d7d inherit pub_methods_classarmnn_1_1_dot_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
131</table>
132<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
133<div class="textblock">
134<p class="definition">Definition at line <a class="el" href="_dot_serializer_8hpp_source.xhtml#l00101">101</a> of file <a class="el" href="_dot_serializer_8hpp_source.xhtml">DotSerializer.hpp</a>.</p>
135</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
136<a id="a8ba78d7bbd1838e28d4208c3a1f2110d"></a>
137<h2 class="memtitle"><span class="permalink"><a href="#a8ba78d7bbd1838e28d4208c3a1f2110d">&#9670;&nbsp;</a></span>DotNode()</h2>
138
139<div class="memitem">
140<div class="memproto">
141<table class="mlabels">
142 <tr>
143 <td class="mlabels-left">
144 <table class="memname">
145 <tr>
146 <td class="memname"><a class="el" href="classarmnn_1_1_dot_node.xhtml">DotNode</a> </td>
147 <td>(</td>
148 <td class="paramtype">std::ostream &amp;&#160;</td>
149 <td class="paramname"><em>stream</em>, </td>
150 </tr>
151 <tr>
152 <td class="paramkey"></td>
153 <td></td>
154 <td class="paramtype"><a class="el" href="namespacearmnn.xhtml#afad4088a9a058114ee5f87246f87bf49">LayerGuid</a>&#160;</td>
155 <td class="paramname"><em>nodeId</em>, </td>
156 </tr>
157 <tr>
158 <td class="paramkey"></td>
159 <td></td>
160 <td class="paramtype">const char *&#160;</td>
161 <td class="paramname"><em>label</em>&#160;</td>
162 </tr>
163 <tr>
164 <td></td>
165 <td>)</td>
166 <td></td><td></td>
167 </tr>
168 </table>
169 </td>
170 <td class="mlabels-right">
171<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
172 </tr>
173</table>
174</div><div class="memdoc">
175
176<p class="definition">Definition at line <a class="el" href="_dot_serializer_8cpp_source.xhtml#l00179">179</a> of file <a class="el" href="_dot_serializer_8cpp_source.xhtml">DotSerializer.cpp</a>.</p>
177
178<p class="reference">References <a class="el" href="_dot_serializer_8hpp_source.xhtml#l00023">DotBase::GetStream()</a>.</p>
179<div class="fragment"><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; : <a class="code" href="classarmnn_1_1_dot_base.xhtml#afba1dd3b85fb26c87e892ed80452d116">DotBase</a>(stream)</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160;{</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; std::stringstream ss;</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; ss &lt;&lt; Indent(4) &lt;&lt; nodeId;</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160;</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; <a class="code" href="classarmnn_1_1_dot_base.xhtml#a99131c6a3da28cceeeb67d732ff39d7d">GetStream</a>() &lt;&lt; ss.str() &lt;&lt; <span class="stringliteral">&quot; &quot;</span>;</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160;</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; m_Contents = std::make_unique&lt;NodeContent&gt;(stream);</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; m_Attributes = std::make_unique&lt;DotAttributeSet&gt;(stream);</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160;</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; <span class="keywordflow">if</span> (std::strlen(label) != 0)</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160; {</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160; m_Contents-&gt;SetName(label);</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160; }</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; <span class="keywordflow">else</span></div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160; {</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; m_Contents-&gt;SetName(<span class="stringliteral">&quot;&lt;noname&gt;&quot;</span>);</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; }</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160;}</div><div class="ttc" id="classarmnn_1_1_dot_base_xhtml_afba1dd3b85fb26c87e892ed80452d116"><div class="ttname"><a href="classarmnn_1_1_dot_base.xhtml#afba1dd3b85fb26c87e892ed80452d116">armnn::DotBase::DotBase</a></div><div class="ttdeci">DotBase(std::ostream &amp;stream)</div><div class="ttdef"><b>Definition:</b> <a href="_dot_serializer_8hpp_source.xhtml#l00020">DotSerializer.hpp:20</a></div></div>
180<div class="ttc" id="classarmnn_1_1_dot_base_xhtml_a99131c6a3da28cceeeb67d732ff39d7d"><div class="ttname"><a href="classarmnn_1_1_dot_base.xhtml#a99131c6a3da28cceeeb67d732ff39d7d">armnn::DotBase::GetStream</a></div><div class="ttdeci">std::ostream &amp; GetStream()</div><div class="ttdef"><b>Definition:</b> <a href="_dot_serializer_8hpp_source.xhtml#l00023">DotSerializer.hpp:23</a></div></div>
181</div><!-- fragment -->
182</div>
183</div>
184<a id="a1a90b7c27390c5b4f7828a0c9917f6fe"></a>
185<h2 class="memtitle"><span class="permalink"><a href="#a1a90b7c27390c5b4f7828a0c9917f6fe">&#9670;&nbsp;</a></span>~DotNode()</h2>
186
187<div class="memitem">
188<div class="memproto">
189 <table class="memname">
190 <tr>
191 <td class="memname">~<a class="el" href="classarmnn_1_1_dot_node.xhtml">DotNode</a> </td>
192 <td>(</td>
193 <td class="paramname"></td><td>)</td>
194 <td></td>
195 </tr>
196 </table>
197</div><div class="memdoc">
198
199<p class="definition">Definition at line <a class="el" href="_dot_serializer_8cpp_source.xhtml#l00200">200</a> of file <a class="el" href="_dot_serializer_8cpp_source.xhtml">DotSerializer.cpp</a>.</p>
200
201<p class="reference">References <a class="el" href="_dot_serializer_8hpp_source.xhtml#l00023">DotBase::GetStream()</a>.</p>
202<div class="fragment"><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160;{</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160; m_Contents.reset(<span class="keyword">nullptr</span>);</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160; m_Attributes.reset(<span class="keyword">nullptr</span>);</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160; <a class="code" href="classarmnn_1_1_dot_base.xhtml#a99131c6a3da28cceeeb67d732ff39d7d">GetStream</a>() &lt;&lt; <span class="stringliteral">&quot;;&quot;</span> &lt;&lt; std::endl;</div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160;}</div><div class="ttc" id="classarmnn_1_1_dot_base_xhtml_a99131c6a3da28cceeeb67d732ff39d7d"><div class="ttname"><a href="classarmnn_1_1_dot_base.xhtml#a99131c6a3da28cceeeb67d732ff39d7d">armnn::DotBase::GetStream</a></div><div class="ttdeci">std::ostream &amp; GetStream()</div><div class="ttdef"><b>Definition:</b> <a href="_dot_serializer_8hpp_source.xhtml#l00023">DotSerializer.hpp:23</a></div></div>
203</div><!-- fragment -->
204</div>
205</div>
206<h2 class="groupheader">Member Function Documentation</h2>
207<a id="a721c9bf7f2e6a2d88d340253ccc19815"></a>
208<h2 class="memtitle"><span class="permalink"><a href="#a721c9bf7f2e6a2d88d340253ccc19815">&#9670;&nbsp;</a></span>GetAttributeSet()</h2>
209
210<div class="memitem">
211<div class="memproto">
212<table class="mlabels">
213 <tr>
214 <td class="mlabels-left">
215 <table class="memname">
216 <tr>
217 <td class="memname"><a class="el" href="classarmnn_1_1_dot_attribute_set.xhtml">DotAttributeSet</a>&amp; GetAttributeSet </td>
218 <td>(</td>
219 <td class="paramname"></td><td>)</td>
220 <td></td>
221 </tr>
222 </table>
223 </td>
224 <td class="mlabels-right">
225<span class="mlabels"><span class="mlabel">inline</span></span> </td>
226 </tr>
227</table>
228</div><div class="memdoc">
229
230<p class="definition">Definition at line <a class="el" href="_dot_serializer_8hpp_source.xhtml#l00108">108</a> of file <a class="el" href="_dot_serializer_8hpp_source.xhtml">DotSerializer.hpp</a>.</p>
231<div class="fragment"><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;{ <span class="keywordflow">return</span> *m_Attributes.get(); }</div></div><!-- fragment -->
232</div>
233</div>
234<a id="a1734bc659f144a8465e22d4b53b8f580"></a>
235<h2 class="memtitle"><span class="permalink"><a href="#a1734bc659f144a8465e22d4b53b8f580">&#9670;&nbsp;</a></span>GetContents()</h2>
236
237<div class="memitem">
238<div class="memproto">
239<table class="mlabels">
240 <tr>
241 <td class="mlabels-left">
242 <table class="memname">
243 <tr>
244 <td class="memname"><a class="el" href="classarmnn_1_1_node_content.xhtml">NodeContent</a>&amp; GetContents </td>
245 <td>(</td>
246 <td class="paramname"></td><td>)</td>
247 <td></td>
248 </tr>
249 </table>
250 </td>
251 <td class="mlabels-right">
252<span class="mlabels"><span class="mlabel">inline</span></span> </td>
253 </tr>
254</table>
255</div><div class="memdoc">
256
257<p class="definition">Definition at line <a class="el" href="_dot_serializer_8hpp_source.xhtml#l00107">107</a> of file <a class="el" href="_dot_serializer_8hpp_source.xhtml">DotSerializer.hpp</a>.</p>
258
259<p class="reference">Referenced by <a class="el" href="_graph_8cpp_source.xhtml#l00081">Graph::SerializeToDot()</a>.</p>
260<div class="fragment"><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;{ <span class="keywordflow">return</span> *m_Contents.get(); }</div></div><!-- fragment -->
261</div>
262</div>
263<hr/>The documentation for this class was generated from the following files:<ul>
264<li>src/armnnUtils/<a class="el" href="_dot_serializer_8hpp_source.xhtml">DotSerializer.hpp</a></li>
265<li>src/armnnUtils/<a class="el" href="_dot_serializer_8cpp_source.xhtml">DotSerializer.cpp</a></li>
266</ul>
267</div><!-- contents -->
268</div><!-- doc-content -->
269<!-- start footer part -->
270<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
271 <ul>
272 <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_dot_node.xhtml">DotNode</a></li>
273 <li class="footer">Generated on Fri Mar 13 2020 16:09:17 for ArmNN by
274 <a href="http://www.doxygen.org/index.html">
275 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
276 </ul>
277</div>
278</body>
279</html>