automotive/dbc
1
0 Fork 0
Code Issues 8 Pull Requests Actions Packages Projects Releases Wiki Activity

update documentation

Browse Source
This commit is contained in:
deeaitch committed 2026-10-07 20:14:24 -04:00
1 parent 1d56a37090
commit 21d6f12163
190 files changed
+9608 -2928
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/html/tree__node_8h_source.html
+35 -27
View File
@@ -132,48 +132,56 @@ $(document).ready(function(){initNavTree('tree__node_8h_source.html',''); initRe
<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> &amp;) = <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> &amp;operator=(<span class="keyword">const</span> <a class="code hl_class" href="classTreeNode.html">TreeNode</a> &amp;) = <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"> 59</span> <a class="code hl_function" href="classTreeNode.html#a984a98d5ccf7ef1f5a18094c6821f35d">TreeNode</a>(<a class="code hl_class" href="classTreeNode.html">TreeNode</a> &amp;&amp;) = <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> &amp;operator=(<a class="code hl_class" href="classTreeNode.html">TreeNode</a> &amp;&amp;) = <span class="keywordflow">default</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> &amp;&amp;) = <span class="keyword">delete</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> &amp;operator=(<a class="code hl_class" href="classTreeNode.html">TreeNode</a> &amp;&amp;) = <span class="keyword">delete</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&lt;TreeNode&gt; child);</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="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">const</span> <a class="code hl_class" href="classTreeNode.html">TreeNode</a> *<a class="code hl_function" href="classTreeNode.html#aa48fbc17903eb8cfa40353e29f853c6f">GetParent</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</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#ad501f97eeec7f7d3353bfae838fbb6a8">GetRow</a>() <span class="keyword">const</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> </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> </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="l00078" name="l00078"></a><span class="lineno"> 78</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="l00079" name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</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="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</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="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 &amp;<a class="code hl_function" href="classTreeNode.html#aaac5b8d9dc9e5ae1f367d1adbcf20e18">GetName</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</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="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="l00104" name="l00104"></a><span class="lineno"> 104</span> <span class="keyword">const</span> std::string &amp;<a class="code hl_function" href="classTreeNode.html#aaac5b8d9dc9e5ae1f367d1adbcf20e18">GetName</a>() <span class="keyword">const</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="l00110" name="l00110"></a><span class="lineno"> 110</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="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"> 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&lt;std::unique_ptr&lt;TreeNode&gt;&gt; m_children;</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> std::unique_ptr&lt;FrameInfo&gt; m_frame;</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> std::unique_ptr&lt;SignalInfo&gt; m_signal;</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span>};</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</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="l00117" name="l00117"></a><span class="lineno"> 117</span> </div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> <a class="code hl_class" href="classTreeNode.html">TreeNode</a> *m_parent = <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> std::size_t m_row = 0U;</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> <a class="code hl_enumeration" href="tree__node_8h.html#acac9cbaeea226ed297804c012dc12b16">NodeType</a> m_type;</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> std::string m_name;</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> std::vector&lt;std::unique_ptr&lt;TreeNode&gt;&gt; m_children;</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> std::unique_ptr&lt;FrameInfo&gt; m_frame;</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> std::unique_ptr&lt;SignalInfo&gt; m_signal;</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span>};</div>
</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="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> </div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</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_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#l00061">tree_node.cpp:61</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#l00035">tree_node.cpp: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#l00064">tree_node.cpp:64</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#l00038">tree_node.cpp:38</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#l00026">tree_node.cpp:26</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#l00053">tree_node.cpp:53</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#l00031">tree_node.cpp:31</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#l00049">tree_node.cpp:49</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#l00057">tree_node.cpp:57</a></div></div>
<div class="ttc" id="aclassTreeNode_html_aa48fbc17903eb8cfa40353e29f853c6f"><div class="ttname"><a href="classTreeNode.html#aa48fbc17903eb8cfa40353e29f853c6f">TreeNode::GetParent</a></div><div class="ttdeci">const TreeNode * GetParent() const</div><div class="ttdef"><b>Definition</b> <a href="tree__node_8cpp_source.html#l00068">tree_node.cpp:68</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#l00056">tree_node.cpp:56</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#l00034">tree_node.cpp:34</a></div></div>
<div class="ttc" id="aclassTreeNode_html_ad501f97eeec7f7d3353bfae838fbb6a8"><div class="ttname"><a href="classTreeNode.html#ad501f97eeec7f7d3353bfae838fbb6a8">TreeNode::GetRow</a></div><div class="ttdeci">std::size_t GetRow() const</div><div class="ttdef"><b>Definition</b> <a href="tree__node_8cpp_source.html#l00072">tree_node.cpp:72</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#l00052">tree_node.cpp:52</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#l00060">tree_node.cpp:60</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>
<div class="ttc" id="asignal__info_8h_html"><div class="ttname"><a href="signal__info_8h.html">signal_info.h</a></div><div class="ttdoc">Created: 2026-03-13 Author: Deeaitch (Dim. Himro)</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="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#l00024">signal_info.h:24</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><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->