automotive/dbc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
38ce043ae083fccd352d4ea3c75c690bd4ef77b8
dbc/docs/html/tree__node_8cpp_source.html
deeaitch 38ce043ae0 updated documentation
2026-06-14 21:05:20 -04:00

178 lines
19 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>DBC Framework: tree_node.cpp 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>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">DBC Framework
</div>
<div id="projectbrief">DBC parsing and CAN signal decoding framework</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;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&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('tree__node_8cpp_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.cpp</div></div>
</div><!--header-->
<div class="contents">
<a href="tree__node_8cpp.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">#include &quot;<a class="code" href="tree__node_8h.html">tree_node.h</a>&quot;</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="classTreeNode.html#a984a98d5ccf7ef1f5a18094c6821f35d"> 14</a></span><a class="code hl_function" href="classTreeNode.html#a984a98d5ccf7ef1f5a18094c6821f35d">TreeNode::TreeNode</a>()</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> : m_type (<a class="code hl_enumeration" href="tree__node_8h.html#acac9cbaeea226ed297804c012dc12b16">NodeType</a>::Root)</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> , m_name (<span class="stringliteral">&quot;dbc&quot;</span>)</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> , m_children()</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> , m_frame()</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> , m_signal() {</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span>}</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="classTreeNode.html#a8e38dd591d8801d7ee3a7dbad90c67fc"> 22</a></span><a class="code hl_function" href="classTreeNode.html#a984a98d5ccf7ef1f5a18094c6821f35d">TreeNode::TreeNode</a> (<span class="keyword">const</span> <a class="code hl_struct" href="structFrameInfo.html">FrameInfo</a> &amp;frame)</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> : m_type (<a class="code hl_enumeration" href="tree__node_8h.html#acac9cbaeea226ed297804c012dc12b16">NodeType</a>::Frame)</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> , m_name (frame.name)</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> , m_children()</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> , m_frame (new <a class="code hl_struct" href="structFrameInfo.html">FrameInfo</a> (frame))</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> , m_signal() {</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span>}</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="classTreeNode.html#ab9f00f5253d56461bb2d420fd639c5ae"> 30</a></span><a class="code hl_function" href="classTreeNode.html#a984a98d5ccf7ef1f5a18094c6821f35d">TreeNode::TreeNode</a> (<span class="keyword">const</span> <a class="code hl_struct" href="structSignalInfo.html">SignalInfo</a> &amp;signal)</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> : m_type (<a class="code hl_enumeration" href="tree__node_8h.html#acac9cbaeea226ed297804c012dc12b16">NodeType</a>::Signal)</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> , m_name (signal.name)</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> , m_children()</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> , m_frame()</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> , m_signal (new <a class="code hl_struct" href="structSignalInfo.html">SignalInfo</a> (signal)) {</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>}</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="classTreeNode.html#a6161f2ebb92184eab4215d121870e788"> 38</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="classTreeNode.html#a6161f2ebb92184eab4215d121870e788">TreeNode::AddChild</a> (std::unique_ptr&lt;TreeNode&gt; child) {</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keywordflow">if</span> (child)</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> m_children.push_back (std::move (child));</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span>}</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="classTreeNode.html#abdd82460187dca8d3e5d66f5d5c529ea"> 43</a></span>std::size_t <a class="code hl_function" href="classTreeNode.html#abdd82460187dca8d3e5d66f5d5c529ea">TreeNode::GetChildCount</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keywordflow">return</span> m_children.size();</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span>}</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="classTreeNode.html#a4727ff801a2d1b9323c5ae50a35457a6"> 47</a></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">TreeNode::GetChild</a> (std::size_t index)<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keywordflow">if</span> (index &gt;= m_children.size())</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keywordflow">return</span> m_children[index].get();</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span>}</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#a81047bd7d2a4cc96b9ef5e20d0d63b5f"> 54</a></span><a class="code hl_class" href="classTreeNode.html">TreeNode</a> *<a class="code hl_function" href="classTreeNode.html#a4727ff801a2d1b9323c5ae50a35457a6">TreeNode::GetChild</a> (std::size_t index) {</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordflow">if</span> (index &gt;= m_children.size())</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keywordflow">return</span> m_children[index].get();</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span>}</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="classTreeNode.html#afa2f4b0aafa12d3d41ed00df8e0250c9"> 61</a></span><a class="code hl_enumeration" href="tree__node_8h.html#acac9cbaeea226ed297804c012dc12b16">NodeType</a> <a class="code hl_function" href="classTreeNode.html#afa2f4b0aafa12d3d41ed00df8e0250c9">TreeNode::GetType</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keywordflow">return</span> m_type;</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span>}</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="classTreeNode.html#aaac5b8d9dc9e5ae1f367d1adbcf20e18"> 65</a></span><span class="keyword">const</span> std::string &amp;<a class="code hl_function" href="classTreeNode.html#aaac5b8d9dc9e5ae1f367d1adbcf20e18">TreeNode::GetName</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keywordflow">return</span> m_name;</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span>}</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="classTreeNode.html#afc503b40004764163605d6dbdb4ef811"> 69</a></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">TreeNode::GetFrame</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keywordflow">return</span> m_frame.get();</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span>}</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="classTreeNode.html#a226518612d0d00b5988a2c44fc21d3f1"> 73</a></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">TreeNode::GetSignal</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keywordflow">return</span> m_signal.get();</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</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_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_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_a6161f2ebb92184eab4215d121870e788"><div class="ttname"><a href="classTreeNode.html#a6161f2ebb92184eab4215d121870e788">TreeNode::AddChild</a></div><div class="ttdeci">void AddChild(std::unique_ptr&lt; TreeNode &gt; 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_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 &amp; 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_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="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"><div class="ttname"><a href="tree__node_8h.html">tree_node.h</a></div><div class="ttdoc">Created: 2026-03-13 Author: Deeaitch (Dim. Himro)</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><!-- fragment --></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="tree__node_8cpp.html">tree_node.cpp</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 View Git Blame Copy Permalink