updated documentation
This commit is contained in:
@@ -5,10 +5,17 @@
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
||||
<meta name="generator" content="Doxygen 1.9.4"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>DBC framework: tree_node.h Source File</title>
|
||||
<title>DBC Framework: tree_node.h Source File</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>
|
||||
<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>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
<body>
|
||||
@@ -18,8 +25,9 @@
|
||||
<tbody>
|
||||
<tr id="projectrow">
|
||||
<td id="projectalign">
|
||||
<div id="projectname">DBC framework
|
||||
<div id="projectname">DBC Framework
|
||||
</div>
|
||||
<div id="projectbrief">DBC parsing and CAN signal decoding framework</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -27,37 +35,58 @@
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.9.4 -->
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
||||
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="files.html"><span>File List</span></a></li>
|
||||
<li><a href="globals.html"><span>File Members</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
|
||||
/* @license-end */
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search');
|
||||
$(document).ready(function() { init_search(); });
|
||||
});
|
||||
/* @license-end */
|
||||
</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">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(document).ready(function(){initNavTree('tree__node_8h_source.html',''); initResizable(); });
|
||||
/* @license-end */
|
||||
</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="headertitle"><div class="title">tree_node.h</div></div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<a href="tree__node_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/**</span></div>
|
||||
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * @file tree_node.h</span></div>
|
||||
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * @brief</span></div>
|
||||
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> *</span></div>
|
||||
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * Created: 2026-03-13</span></div>
|
||||
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * Author: Deeaitch (Dim. Himro)</span></div>
|
||||
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> *</span></div>
|
||||
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * Licensed under the MIT License.</span></div>
|
||||
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * See LICENSE file in the project root for full license text.</span></div>
|
||||
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> */</span></div>
|
||||
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
|
||||
<a href="tree__node_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span> </div>
|
||||
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#ifndef TREE_NODE_H</span></div>
|
||||
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#define TREE_NODE_H</span></div>
|
||||
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
|
||||
@@ -68,121 +97,61 @@
|
||||
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
|
||||
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#include "<a class="code" href="frame__info_8h.html">frame_info.h</a>"</span></div>
|
||||
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include "<a class="code" href="signal__info_8h.html">signal_info.h</a>"</span></div>
|
||||
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment">/**</span></div>
|
||||
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment"> * @brief Type of a tree node.</span></div>
|
||||
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"> */</span></div>
|
||||
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
|
||||
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="tree__node_8h.html#acac9cbaeea226ed297804c012dc12b16"> 26</a></span><span class="keyword">enum class</span> <a class="code hl_enumeration" href="tree__node_8h.html#acac9cbaeea226ed297804c012dc12b16">NodeType</a> {</div>
|
||||
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <a class="code hl_enumvalue" href="tree__node_8h.html#acac9cbaeea226ed297804c012dc12b16afa03eb688ad8aa1db593d33dabd89bad">Root</a>,</div>
|
||||
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <a class="code hl_enumvalue" href="tree__node_8h.html#acac9cbaeea226ed297804c012dc12b16a3bb3e8c8a24891ba0f7608bcc96f8b0a">Frame</a>,</div>
|
||||
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <a class="code hl_enumvalue" href="tree__node_8h.html#acac9cbaeea226ed297804c012dc12b16a085fea7abdc5d904fe69a3081efd7398">Signal</a></div>
|
||||
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> Root,</div>
|
||||
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> Frame,</div>
|
||||
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> Signal</div>
|
||||
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span>};</div>
|
||||
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment">/**</span></div>
|
||||
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment"> * @brief Tree node for later use in model/view or other hierarchy consumers.</span></div>
|
||||
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment"> */</span></div>
|
||||
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
|
||||
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="classTreeNode.html"> 35</a></span><span class="keyword">class </span><a class="code hl_class" href="classTreeNode.html">TreeNode</a> {</div>
|
||||
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">public</span>:<span class="comment"></span></div>
|
||||
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment"> /**</span></div>
|
||||
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment"> * @brief Create root node.</span></div>
|
||||
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment"> */</span></div>
|
||||
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">public</span>:</div>
|
||||
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <a class="code hl_function" href="classTreeNode.html#a984a98d5ccf7ef1f5a18094c6821f35d">TreeNode</a>();</div>
|
||||
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment"> /**</span></div>
|
||||
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment"> * @brief Create frame node.</span></div>
|
||||
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="comment"> * @param frame Frame payload.</span></div>
|
||||
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment"> */</span></div>
|
||||
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
|
||||
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classTreeNode.html#a984a98d5ccf7ef1f5a18094c6821f35d">TreeNode</a> (<span class="keyword">const</span> <a class="code hl_struct" href="structFrameInfo.html">FrameInfo</a> &frame);</div>
|
||||
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment"> /**</span></div>
|
||||
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment"> * @brief Create signal node.</span></div>
|
||||
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment"> * @param signal Signal payload.</span></div>
|
||||
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment"> */</span></div>
|
||||
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
|
||||
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classTreeNode.html#a984a98d5ccf7ef1f5a18094c6821f35d">TreeNode</a> (<span class="keyword">const</span> <a class="code hl_struct" href="structSignalInfo.html">SignalInfo</a> &signal);</div>
|
||||
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
|
||||
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="classTreeNode.html#a89eb1eb0e25fccaa83c780b85f95b570"> 54</a></span> <a class="code hl_function" href="classTreeNode.html#a89eb1eb0e25fccaa83c780b85f95b570">~TreeNode</a>() = <span class="keywordflow">default</span>;</div>
|
||||
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <a class="code hl_class" href="classTreeNode.html">~TreeNode</a>() = <span class="keywordflow">default</span>;</div>
|
||||
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
|
||||
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="classTreeNode.html#a4d3054a033accf3e38ea132002fc35ff"> 56</a></span> <a class="code hl_function" href="classTreeNode.html#a4d3054a033accf3e38ea132002fc35ff">TreeNode</a> (<span class="keyword">const</span> <a class="code hl_class" href="classTreeNode.html">TreeNode</a> &) = <span class="keyword">delete</span>;</div>
|
||||
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="classTreeNode.html#ad6ce97dcf532b452d520452b6d000daa"> 57</a></span> <a class="code hl_class" href="classTreeNode.html">TreeNode</a> &<a class="code hl_function" href="classTreeNode.html#ad6ce97dcf532b452d520452b6d000daa">operator= </a>(<span class="keyword">const</span> <a class="code hl_class" href="classTreeNode.html">TreeNode</a> &) = <span class="keyword">delete</span>;</div>
|
||||
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <a class="code hl_function" href="classTreeNode.html#a984a98d5ccf7ef1f5a18094c6821f35d">TreeNode</a> (<span class="keyword">const</span> <a class="code hl_class" href="classTreeNode.html">TreeNode</a> &) = <span class="keyword">delete</span>;</div>
|
||||
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <a class="code hl_class" href="classTreeNode.html">TreeNode</a> &operator= (<span class="keyword">const</span> <a class="code hl_class" href="classTreeNode.html">TreeNode</a> &) = <span class="keyword">delete</span>;</div>
|
||||
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
|
||||
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="classTreeNode.html#a35724af755b5d0c43de40a723ef81ec1"> 59</a></span> <a class="code hl_function" href="classTreeNode.html#a35724af755b5d0c43de40a723ef81ec1">TreeNode</a> (<a class="code hl_class" href="classTreeNode.html">TreeNode</a> &&) = <span class="keywordflow">default</span>;</div>
|
||||
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="classTreeNode.html#a88fbcbec9c64d888b19c5edb95059a95"> 60</a></span> <a class="code hl_class" href="classTreeNode.html">TreeNode</a> &<a class="code hl_function" href="classTreeNode.html#ad6ce97dcf532b452d520452b6d000daa">operator= </a>(<a class="code hl_class" href="classTreeNode.html">TreeNode</a> &&) = <span class="keywordflow">default</span>;</div>
|
||||
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment"> /**</span></div>
|
||||
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment"> * @brief Add child node.</span></div>
|
||||
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="comment"> * @param child Child node to add.</span></div>
|
||||
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="comment"> */</span></div>
|
||||
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <a class="code hl_function" href="classTreeNode.html#a984a98d5ccf7ef1f5a18094c6821f35d">TreeNode</a> (<a class="code hl_class" href="classTreeNode.html">TreeNode</a> &&) = <span class="keywordflow">default</span>;</div>
|
||||
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <a class="code hl_class" href="classTreeNode.html">TreeNode</a> &operator= (<a class="code hl_class" href="classTreeNode.html">TreeNode</a> &&) = <span class="keywordflow">default</span>;</div>
|
||||
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
|
||||
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classTreeNode.html#a6161f2ebb92184eab4215d121870e788">AddChild</a> (std::unique_ptr<TreeNode> child);</div>
|
||||
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="comment"> /**</span></div>
|
||||
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="comment"> * @brief Get child count.</span></div>
|
||||
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="comment"> * @return Number of children.</span></div>
|
||||
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span><span class="comment"> */</span></div>
|
||||
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
|
||||
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> std::size_t <a class="code hl_function" href="classTreeNode.html#abdd82460187dca8d3e5d66f5d5c529ea">GetChildCount</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="comment"> /**</span></div>
|
||||
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment"> * @brief Get child by index.</span></div>
|
||||
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="comment"> * @param index Child index.</span></div>
|
||||
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="comment"> * @return Child pointer or nullptr if index is invalid.</span></div>
|
||||
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="comment"> */</span></div>
|
||||
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
|
||||
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keyword">const</span> <a class="code hl_class" href="classTreeNode.html">TreeNode</a> *<a class="code hl_function" href="classTreeNode.html#a4727ff801a2d1b9323c5ae50a35457a6">GetChild</a> (std::size_t index) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="comment"> /**</span></div>
|
||||
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="comment"> * @brief Get mutable child by index.</span></div>
|
||||
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="comment"> * @param index Child index.</span></div>
|
||||
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="comment"> * @return Child pointer or nullptr if index is invalid.</span></div>
|
||||
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="comment"> */</span></div>
|
||||
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
|
||||
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <a class="code hl_class" href="classTreeNode.html">TreeNode</a> *<a class="code hl_function" href="classTreeNode.html#a4727ff801a2d1b9323c5ae50a35457a6">GetChild</a> (std::size_t index);</div>
|
||||
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="comment"> /**</span></div>
|
||||
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="comment"> * @brief Get node type.</span></div>
|
||||
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="comment"> * @return Node type.</span></div>
|
||||
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="comment"> */</span></div>
|
||||
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
|
||||
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <a class="code hl_enumeration" href="tree__node_8h.html#acac9cbaeea226ed297804c012dc12b16">NodeType</a> <a class="code hl_function" href="classTreeNode.html#afa2f4b0aafa12d3d41ed00df8e0250c9">GetType</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="comment"> /**</span></div>
|
||||
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span><span class="comment"> * @brief Get display name.</span></div>
|
||||
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span><span class="comment"> * @return Node name.</span></div>
|
||||
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span><span class="comment"> */</span></div>
|
||||
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> </div>
|
||||
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">const</span> std::string &<a class="code hl_function" href="classTreeNode.html#aaac5b8d9dc9e5ae1f367d1adbcf20e18">GetName</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span><span class="comment"> /**</span></div>
|
||||
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><span class="comment"> * @brief Get frame payload if node is frame.</span></div>
|
||||
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="comment"> * @return Pointer to frame info or nullptr.</span></div>
|
||||
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span><span class="comment"> */</span></div>
|
||||
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div>
|
||||
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> <span class="keyword">const</span> <a class="code hl_struct" href="structFrameInfo.html">FrameInfo</a> *<a class="code hl_function" href="classTreeNode.html#afc503b40004764163605d6dbdb4ef811">GetFrame</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span><span class="comment"></span> </div>
|
||||
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span><span class="comment"> /**</span></div>
|
||||
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span><span class="comment"> * @brief Get signal payload if node is signal.</span></div>
|
||||
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span><span class="comment"> * @return Pointer to signal info or nullptr.</span></div>
|
||||
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="comment"> */</span></div>
|
||||
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> </div>
|
||||
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> <span class="keyword">const</span> <a class="code hl_struct" href="structSignalInfo.html">SignalInfo</a> *<a class="code hl_function" href="classTreeNode.html#a226518612d0d00b5988a2c44fc21d3f1">GetSignal</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div>
|
||||
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> <span class="keyword">private</span>:</div>
|
||||
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"><a class="line" href="classTreeNode.html#a04bccab9e60a6a78777cd7dfec52d224"> 113</a></span> <a class="code hl_enumeration" href="tree__node_8h.html#acac9cbaeea226ed297804c012dc12b16">NodeType</a> <a class="code hl_variable" href="classTreeNode.html#a04bccab9e60a6a78777cd7dfec52d224">m_type</a>;</div>
|
||||
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"><a class="line" href="classTreeNode.html#ac0ddcb8370e6b51e2d3de6b8211a47f8"> 114</a></span> std::string <a class="code hl_variable" href="classTreeNode.html#ac0ddcb8370e6b51e2d3de6b8211a47f8">m_name</a>;</div>
|
||||
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"><a class="line" href="classTreeNode.html#a1bd61f40df6d36e61021063e3816a351"> 115</a></span> std::vector<std::unique_ptr<TreeNode> > <a class="code hl_variable" href="classTreeNode.html#a1bd61f40df6d36e61021063e3816a351">m_children</a>;</div>
|
||||
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"><a class="line" href="classTreeNode.html#a77ee6aa80774d67ba442a66b45c798c2"> 116</a></span> std::unique_ptr<FrameInfo> <a class="code hl_variable" href="classTreeNode.html#a77ee6aa80774d67ba442a66b45c798c2">m_frame</a>;</div>
|
||||
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"><a class="line" href="classTreeNode.html#ae658355007bc9303f7bfae3bb3ec8386"> 117</a></span> std::unique_ptr<SignalInfo> <a class="code hl_variable" href="classTreeNode.html#ae658355007bc9303f7bfae3bb3ec8386">m_signal</a>;</div>
|
||||
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> <a class="code hl_enumeration" href="tree__node_8h.html#acac9cbaeea226ed297804c012dc12b16">NodeType</a> m_type;</div>
|
||||
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> std::string m_name;</div>
|
||||
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> std::vector<std::unique_ptr<TreeNode> > m_children;</div>
|
||||
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> std::unique_ptr<FrameInfo> m_frame;</div>
|
||||
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> std::unique_ptr<SignalInfo> m_signal;</div>
|
||||
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span>};</div>
|
||||
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> </div>
|
||||
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span><span class="preprocessor">#endif </span><span class="comment">/* TREE_NODE_H */</span><span class="preprocessor"></span></div>
|
||||
<div class="ttc" id="aclassTreeNode_html"><div class="ttname"><a href="classTreeNode.html">TreeNode</a></div><div class="ttdoc">Tree node for later use in model/view or other hierarchy consumers.</div><div class="ttdef"><b>Definition:</b> <a href="tree__node_8h_source.html#l00035">tree_node.h:35</a></div></div>
|
||||
<div class="ttc" id="aclassTreeNode_html_a04bccab9e60a6a78777cd7dfec52d224"><div class="ttname"><a href="classTreeNode.html#a04bccab9e60a6a78777cd7dfec52d224">TreeNode::m_type</a></div><div class="ttdeci">NodeType m_type</div><div class="ttdef"><b>Definition:</b> <a href="tree__node_8h_source.html#l00113">tree_node.h:113</a></div></div>
|
||||
<div class="ttc" id="aclassTreeNode_html_a1bd61f40df6d36e61021063e3816a351"><div class="ttname"><a href="classTreeNode.html#a1bd61f40df6d36e61021063e3816a351">TreeNode::m_children</a></div><div class="ttdeci">std::vector< std::unique_ptr< TreeNode > > m_children</div><div class="ttdef"><b>Definition:</b> <a href="tree__node_8h_source.html#l00115">tree_node.h:115</a></div></div>
|
||||
<div class="ttc" id="aclassTreeNode_html_a226518612d0d00b5988a2c44fc21d3f1"><div class="ttname"><a href="classTreeNode.html#a226518612d0d00b5988a2c44fc21d3f1">TreeNode::GetSignal</a></div><div class="ttdeci">const SignalInfo * GetSignal() const</div><div class="ttdoc">Get signal payload if node is signal.</div><div class="ttdef"><b>Definition:</b> <a href="tree__node_8cpp_source.html#l00073">tree_node.cpp:73</a></div></div>
|
||||
<div class="ttc" id="aclassTreeNode_html_a35724af755b5d0c43de40a723ef81ec1"><div class="ttname"><a href="classTreeNode.html#a35724af755b5d0c43de40a723ef81ec1">TreeNode::TreeNode</a></div><div class="ttdeci">TreeNode(TreeNode &&)=default</div></div>
|
||||
<div class="ttc" id="aclassTreeNode_html_a4727ff801a2d1b9323c5ae50a35457a6"><div class="ttname"><a href="classTreeNode.html#a4727ff801a2d1b9323c5ae50a35457a6">TreeNode::GetChild</a></div><div class="ttdeci">const TreeNode * GetChild(std::size_t index) const</div><div class="ttdoc">Get child by index.</div><div class="ttdef"><b>Definition:</b> <a href="tree__node_8cpp_source.html#l00047">tree_node.cpp:47</a></div></div>
|
||||
<div class="ttc" id="aclassTreeNode_html_a4d3054a033accf3e38ea132002fc35ff"><div class="ttname"><a href="classTreeNode.html#a4d3054a033accf3e38ea132002fc35ff">TreeNode::TreeNode</a></div><div class="ttdeci">TreeNode(const TreeNode &)=delete</div></div>
|
||||
<div class="ttc" id="aclassTreeNode_html_a6161f2ebb92184eab4215d121870e788"><div class="ttname"><a href="classTreeNode.html#a6161f2ebb92184eab4215d121870e788">TreeNode::AddChild</a></div><div class="ttdeci">void AddChild(std::unique_ptr< TreeNode > child)</div><div class="ttdoc">Add child node.</div><div class="ttdef"><b>Definition:</b> <a href="tree__node_8cpp_source.html#l00038">tree_node.cpp:38</a></div></div>
|
||||
<div class="ttc" id="aclassTreeNode_html_a77ee6aa80774d67ba442a66b45c798c2"><div class="ttname"><a href="classTreeNode.html#a77ee6aa80774d67ba442a66b45c798c2">TreeNode::m_frame</a></div><div class="ttdeci">std::unique_ptr< FrameInfo > m_frame</div><div class="ttdef"><b>Definition:</b> <a href="tree__node_8h_source.html#l00116">tree_node.h:116</a></div></div>
|
||||
<div class="ttc" id="aclassTreeNode_html_a89eb1eb0e25fccaa83c780b85f95b570"><div class="ttname"><a href="classTreeNode.html#a89eb1eb0e25fccaa83c780b85f95b570">TreeNode::~TreeNode</a></div><div class="ttdeci">~TreeNode()=default</div></div>
|
||||
<div class="ttc" id="aclassTreeNode_html_a984a98d5ccf7ef1f5a18094c6821f35d"><div class="ttname"><a href="classTreeNode.html#a984a98d5ccf7ef1f5a18094c6821f35d">TreeNode::TreeNode</a></div><div class="ttdeci">TreeNode()</div><div class="ttdoc">Create root node.</div><div class="ttdef"><b>Definition:</b> <a href="tree__node_8cpp_source.html#l00014">tree_node.cpp:14</a></div></div>
|
||||
<div class="ttc" id="aclassTreeNode_html_aaac5b8d9dc9e5ae1f367d1adbcf20e18"><div class="ttname"><a href="classTreeNode.html#aaac5b8d9dc9e5ae1f367d1adbcf20e18">TreeNode::GetName</a></div><div class="ttdeci">const std::string & GetName() const</div><div class="ttdoc">Get display name.</div><div class="ttdef"><b>Definition:</b> <a href="tree__node_8cpp_source.html#l00065">tree_node.cpp:65</a></div></div>
|
||||
<div class="ttc" id="aclassTreeNode_html_abdd82460187dca8d3e5d66f5d5c529ea"><div class="ttname"><a href="classTreeNode.html#abdd82460187dca8d3e5d66f5d5c529ea">TreeNode::GetChildCount</a></div><div class="ttdeci">std::size_t GetChildCount() const</div><div class="ttdoc">Get child count.</div><div class="ttdef"><b>Definition:</b> <a href="tree__node_8cpp_source.html#l00043">tree_node.cpp:43</a></div></div>
|
||||
<div class="ttc" id="aclassTreeNode_html_ac0ddcb8370e6b51e2d3de6b8211a47f8"><div class="ttname"><a href="classTreeNode.html#ac0ddcb8370e6b51e2d3de6b8211a47f8">TreeNode::m_name</a></div><div class="ttdeci">std::string m_name</div><div class="ttdef"><b>Definition:</b> <a href="tree__node_8h_source.html#l00114">tree_node.h:114</a></div></div>
|
||||
<div class="ttc" id="aclassTreeNode_html_ad6ce97dcf532b452d520452b6d000daa"><div class="ttname"><a href="classTreeNode.html#ad6ce97dcf532b452d520452b6d000daa">TreeNode::operator=</a></div><div class="ttdeci">TreeNode & operator=(const TreeNode &)=delete</div></div>
|
||||
<div class="ttc" id="aclassTreeNode_html_ae658355007bc9303f7bfae3bb3ec8386"><div class="ttname"><a href="classTreeNode.html#ae658355007bc9303f7bfae3bb3ec8386">TreeNode::m_signal</a></div><div class="ttdeci">std::unique_ptr< SignalInfo > m_signal</div><div class="ttdef"><b>Definition:</b> <a href="tree__node_8h_source.html#l00117">tree_node.h:117</a></div></div>
|
||||
<div class="ttc" id="aclassTreeNode_html_afa2f4b0aafa12d3d41ed00df8e0250c9"><div class="ttname"><a href="classTreeNode.html#afa2f4b0aafa12d3d41ed00df8e0250c9">TreeNode::GetType</a></div><div class="ttdeci">NodeType GetType() const</div><div class="ttdoc">Get node type.</div><div class="ttdef"><b>Definition:</b> <a href="tree__node_8cpp_source.html#l00061">tree_node.cpp:61</a></div></div>
|
||||
<div class="ttc" id="aclassTreeNode_html_afc503b40004764163605d6dbdb4ef811"><div class="ttname"><a href="classTreeNode.html#afc503b40004764163605d6dbdb4ef811">TreeNode::GetFrame</a></div><div class="ttdeci">const FrameInfo * GetFrame() const</div><div class="ttdoc">Get frame payload if node is frame.</div><div class="ttdef"><b>Definition:</b> <a href="tree__node_8cpp_source.html#l00069">tree_node.cpp:69</a></div></div>
|
||||
<div class="ttc" id="aframe__info_8h_html"><div class="ttname"><a href="frame__info_8h.html">frame_info.h</a></div><div class="ttdoc">Created: 2026-03-13 Author: Deeaitch (Dim. Himro)</div></div>
|
||||
@@ -190,13 +159,14 @@
|
||||
<div class="ttc" id="astructFrameInfo_html"><div class="ttname"><a href="structFrameInfo.html">FrameInfo</a></div><div class="ttdoc">Describes one CAN frame from a DBC file.</div><div class="ttdef"><b>Definition:</b> <a href="frame__info_8h_source.html#l00024">frame_info.h:24</a></div></div>
|
||||
<div class="ttc" id="astructSignalInfo_html"><div class="ttname"><a href="structSignalInfo.html">SignalInfo</a></div><div class="ttdoc">Describes one signal inside a DBC frame.</div><div class="ttdef"><b>Definition:</b> <a href="signal__info_8h_source.html#l00022">signal_info.h:22</a></div></div>
|
||||
<div class="ttc" id="atree__node_8h_html_acac9cbaeea226ed297804c012dc12b16"><div class="ttname"><a href="tree__node_8h.html#acac9cbaeea226ed297804c012dc12b16">NodeType</a></div><div class="ttdeci">NodeType</div><div class="ttdoc">Type of a tree node.</div><div class="ttdef"><b>Definition:</b> <a href="tree__node_8h_source.html#l00026">tree_node.h:26</a></div></div>
|
||||
<div class="ttc" id="atree__node_8h_html_acac9cbaeea226ed297804c012dc12b16a085fea7abdc5d904fe69a3081efd7398"><div class="ttname"><a href="tree__node_8h.html#acac9cbaeea226ed297804c012dc12b16a085fea7abdc5d904fe69a3081efd7398">NodeType::Signal</a></div><div class="ttdeci">@ Signal</div></div>
|
||||
<div class="ttc" id="atree__node_8h_html_acac9cbaeea226ed297804c012dc12b16a3bb3e8c8a24891ba0f7608bcc96f8b0a"><div class="ttname"><a href="tree__node_8h.html#acac9cbaeea226ed297804c012dc12b16a3bb3e8c8a24891ba0f7608bcc96f8b0a">NodeType::Frame</a></div><div class="ttdeci">@ Frame</div></div>
|
||||
<div class="ttc" id="atree__node_8h_html_acac9cbaeea226ed297804c012dc12b16afa03eb688ad8aa1db593d33dabd89bad"><div class="ttname"><a href="tree__node_8h.html#acac9cbaeea226ed297804c012dc12b16afa03eb688ad8aa1db593d33dabd89bad">NodeType::Root</a></div><div class="ttdeci">@ Root</div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated on Sun Jun 14 2026 20:49:34 for DBC framework by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
|
||||
</small></address>
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="tree__node_8h.html">tree_node.h</a></li>
|
||||
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user