upfate doxygen

This commit is contained in:
deeaitch committed 2026-10-20 13:40:44 -04:00
1 parent a55d1c58ed
commit c43222939f
433 files changed
+15617 -7061

No files matched your search

+55 -41
View File
@@ -108,49 +108,63 @@ $(document).ready(function(){initNavTree('dbc__tree__model_8h_source.html','');
<div class="foldopen" id="foldopen00011" data-start="{" data-end="};">
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="classDbcTreeModel.html"> 11</a></span><span class="keyword">class </span><a class="code hl_class" href="classDbcTreeModel.html">DbcTreeModel</a> : <span class="keyword">public</span> QAbstractItemModel {</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">enum</span> Column { Name,</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> CanId,</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> PayloadLength,</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> StartBit,</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> BitLength,</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <a class="code hl_enumeration" href="decode__database_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a>,</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> Signed,</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> Unit,</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> Comment,</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> ColumnCount };</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// Metadata roles apply on every column; inapplicable roles return invalid QVariant.</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">enum</span> Role { NodeTypeRole = Qt::UserRole + 1,</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> CanIdRole,</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> PayloadLengthRole,</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> StartBitRole,</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> BitLengthRole,</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> LittleEndianRole,</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> SignedRole,</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> UnitRole,</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> CommentRole,</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> ValueDescriptionsRole,</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> ExtendedRole };</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classDbcTreeModel.html">DbcTreeModel</a>(QObject *parent = <span class="keyword">nullptr</span>);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">void</span> SetTree(std::unique_ptr&lt;TreeNode&gt; root);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> QModelIndex index(<span class="keywordtype">int</span> row, <span class="keywordtype">int</span> column, <span class="keyword">const</span> QModelIndex &amp;parent = QModelIndex()) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> QModelIndex parent(<span class="keyword">const</span> QModelIndex &amp;child) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordtype">int</span> rowCount(<span class="keyword">const</span> QModelIndex &amp;parent = QModelIndex()) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordtype">int</span> columnCount(<span class="keyword">const</span> QModelIndex &amp;parent = QModelIndex()) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> QVariant data(<span class="keyword">const</span> QModelIndex &amp;index, <span class="keywordtype">int</span> role = Qt::DisplayRole) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> QVariant headerData(<span class="keywordtype">int</span> section, Qt::Orientation orientation, <span class="keywordtype">int</span> role = Qt::DisplayRole) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> Qt::ItemFlags flags(<span class="keyword">const</span> QModelIndex &amp;index) <span class="keyword">const override</span>;</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><span class="keyword">private</span>:</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">const</span> <a class="code hl_class" href="classTreeNode.html">TreeNode</a> *Node(<span class="keyword">const</span> QModelIndex &amp;index) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> std::unique_ptr&lt;TreeNode&gt; m_root;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span>};</div>
<div class="foldopen" id="foldopen00014" data-start="{" data-end="};">
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="classDbcTreeModel.html#a5e31be609fae4d7dfdd79140f56069ae"> 14</a></span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="classDbcTreeModel.html#a5e31be609fae4d7dfdd79140f56069ae">Column</a> { Name,</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> CanId,</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> PayloadLength,</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> StartBit,</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> BitLength,</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <a class="code hl_enumeration" href="decode__database_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a>,</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> Signed,</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> Unit,</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> Comment,</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> ColumnCount };</div>
</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// Metadata roles apply on every column; inapplicable roles return invalid QVariant.</span></div>
<div class="foldopen" id="foldopen00026" data-start="{" data-end="};">
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="classDbcTreeModel.html#a0f360d424848c6c39f2312e6209b0dfd"> 26</a></span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="classDbcTreeModel.html#a0f360d424848c6c39f2312e6209b0dfd">Role</a> { NodeTypeRole = Qt::UserRole + 1,</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> CanIdRole,</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> PayloadLengthRole,</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> StartBitRole,</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> BitLengthRole,</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> LittleEndianRole,</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> SignedRole,</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> UnitRole,</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> CommentRole,</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> ValueDescriptionsRole,</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> ExtendedRole };</div>
</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classDbcTreeModel.html">DbcTreeModel</a>(QObject *<a class="code hl_function" href="classDbcTreeModel.html#ae40bb8b8a26d205f178c6dd1134ff4b3">parent</a> = <span class="keyword">nullptr</span>);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classDbcTreeModel.html#a8cb5a81d456cdead42b75fd3462ee00a">SetTree</a>(std::unique_ptr&lt;TreeNode&gt; root);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> QModelIndex <a class="code hl_function" href="classDbcTreeModel.html#a8caeb5ec6141eb3e446e48df3c70b3ad">index</a>(<span class="keywordtype">int</span> row, <span class="keywordtype">int</span> column, <span class="keyword">const</span> QModelIndex &amp;<a class="code hl_function" href="classDbcTreeModel.html#ae40bb8b8a26d205f178c6dd1134ff4b3">parent</a> = QModelIndex()) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> QModelIndex <a class="code hl_function" href="classDbcTreeModel.html#ae40bb8b8a26d205f178c6dd1134ff4b3">parent</a>(<span class="keyword">const</span> QModelIndex &amp;child) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keywordtype">int</span> <a class="code hl_function" href="classDbcTreeModel.html#a30bed0d65342917c19d9183da55af452">rowCount</a>(<span class="keyword">const</span> QModelIndex &amp;<a class="code hl_function" href="classDbcTreeModel.html#ae40bb8b8a26d205f178c6dd1134ff4b3">parent</a> = QModelIndex()) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keywordtype">int</span> <a class="code hl_function" href="classDbcTreeModel.html#a397f885e7fd45c387825b4357b875c10">columnCount</a>(<span class="keyword">const</span> QModelIndex &amp;<a class="code hl_function" href="classDbcTreeModel.html#ae40bb8b8a26d205f178c6dd1134ff4b3">parent</a> = QModelIndex()) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> QVariant <a class="code hl_function" href="classDbcTreeModel.html#aca81d05c81cc48c1185fc36659e96e5b">data</a>(<span class="keyword">const</span> QModelIndex &amp;<a class="code hl_function" href="classDbcTreeModel.html#a8caeb5ec6141eb3e446e48df3c70b3ad">index</a>, <span class="keywordtype">int</span> role = Qt::DisplayRole) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> QVariant <a class="code hl_function" href="classDbcTreeModel.html#aad5834e8edb00808cbfa498ea8c63fe9">headerData</a>(<span class="keywordtype">int</span> section, Qt::Orientation orientation, <span class="keywordtype">int</span> role = Qt::DisplayRole) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> Qt::ItemFlags <a class="code hl_function" href="classDbcTreeModel.html#a8f7842a79144bdb24fa9c5fbdcd37295">flags</a>(<span class="keyword">const</span> QModelIndex &amp;<a class="code hl_function" href="classDbcTreeModel.html#a8caeb5ec6141eb3e446e48df3c70b3ad">index</a>) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">const</span> <a class="code hl_class" href="classTreeNode.html">TreeNode</a> *Node(<span class="keyword">const</span> QModelIndex &amp;<a class="code hl_function" href="classDbcTreeModel.html#a8caeb5ec6141eb3e446e48df3c70b3ad">index</a>) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> std::unique_ptr&lt;TreeNode&gt; m_root;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span>};</div>
</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassDbcTreeModel_html"><div class="ttname"><a href="classDbcTreeModel.html">DbcTreeModel</a></div><div class="ttdef"><b>Definition</b> <a href="dbc__tree__model_8h_source.html#l00011">dbc_tree_model.h:11</a></div></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="adecode__database_8h_html_aaeb92d42f5a6e27b8ba19f18d69d142b"><div class="ttname"><a href="decode__database_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a></div><div class="ttdeci">ByteOrder</div><div class="ttdoc">Signal byte order used for runtime decoding.</div><div class="ttdef"><b>Definition</b> <a href="decode__database_8h_source.html#l00027">decode_database.h:27</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="aclassDbcTreeModel_html_a0f360d424848c6c39f2312e6209b0dfd"><div class="ttname"><a href="classDbcTreeModel.html#a0f360d424848c6c39f2312e6209b0dfd">DbcTreeModel::Role</a></div><div class="ttdeci">Role</div><div class="ttdoc">Typed metadata roles in addition to Qt display roles.</div><div class="ttdef"><b>Definition</b> <a href="dbc__tree__model_8h_source.html#l00026">dbc_tree_model.h:26</a></div></div>
<div class="ttc" id="aclassDbcTreeModel_html_a30bed0d65342917c19d9183da55af452"><div class="ttname"><a href="classDbcTreeModel.html#a30bed0d65342917c19d9183da55af452">DbcTreeModel::rowCount</a></div><div class="ttdeci">int rowCount(const QModelIndex &amp;parent=QModelIndex()) const override</div><div class="ttdoc">Return the child count, capped at the Qt integer limit.</div><div class="ttdef"><b>Definition</b> <a href="dbc__tree__model_8cpp_source.html#l00061">dbc_tree_model.cpp:61</a></div></div>
<div class="ttc" id="aclassDbcTreeModel_html_a397f885e7fd45c387825b4357b875c10"><div class="ttname"><a href="classDbcTreeModel.html#a397f885e7fd45c387825b4357b875c10">DbcTreeModel::columnCount</a></div><div class="ttdeci">int columnCount(const QModelIndex &amp;parent=QModelIndex()) const override</div><div class="ttdoc">Return the fixed metadata column count for this model.</div><div class="ttdef"><b>Definition</b> <a href="dbc__tree__model_8cpp_source.html#l00070">dbc_tree_model.cpp:70</a></div></div>
<div class="ttc" id="aclassDbcTreeModel_html_a5e31be609fae4d7dfdd79140f56069ae"><div class="ttname"><a href="classDbcTreeModel.html#a5e31be609fae4d7dfdd79140f56069ae">DbcTreeModel::Column</a></div><div class="ttdeci">Column</div><div class="ttdoc">Display columns for frame and signal metadata.</div><div class="ttdef"><b>Definition</b> <a href="dbc__tree__model_8h_source.html#l00014">dbc_tree_model.h:14</a></div></div>
<div class="ttc" id="aclassDbcTreeModel_html_a8caeb5ec6141eb3e446e48df3c70b3ad"><div class="ttname"><a href="classDbcTreeModel.html#a8caeb5ec6141eb3e446e48df3c70b3ad">DbcTreeModel::index</a></div><div class="ttdeci">QModelIndex index(int row, int column, const QModelIndex &amp;parent=QModelIndex()) const override</div><div class="ttdoc">Return a child index; only column zero can have children.</div><div class="ttdef"><b>Definition</b> <a href="dbc__tree__model_8cpp_source.html#l00042">dbc_tree_model.cpp:42</a></div></div>
<div class="ttc" id="aclassDbcTreeModel_html_a8cb5a81d456cdead42b75fd3462ee00a"><div class="ttname"><a href="classDbcTreeModel.html#a8cb5a81d456cdead42b75fd3462ee00a">DbcTreeModel::SetTree</a></div><div class="ttdeci">void SetTree(std::unique_ptr&lt; TreeNode &gt; root)</div><div class="ttdoc">Replace the tree and invalidate indexes; reject roots with a parent or non-root type.</div><div class="ttdef"><b>Definition</b> <a href="dbc__tree__model_8cpp_source.html#l00027">dbc_tree_model.cpp:27</a></div></div>
<div class="ttc" id="aclassDbcTreeModel_html_a8f7842a79144bdb24fa9c5fbdcd37295"><div class="ttname"><a href="classDbcTreeModel.html#a8f7842a79144bdb24fa9c5fbdcd37295">DbcTreeModel::flags</a></div><div class="ttdeci">Qt::ItemFlags flags(const QModelIndex &amp;index) const override</div><div class="ttdoc">Allow selecting and enabling valid indexes without editing.</div><div class="ttdef"><b>Definition</b> <a href="dbc__tree__model_8cpp_source.html#l00145">dbc_tree_model.cpp:145</a></div></div>
<div class="ttc" id="aclassDbcTreeModel_html_aad5834e8edb00808cbfa498ea8c63fe9"><div class="ttname"><a href="classDbcTreeModel.html#aad5834e8edb00808cbfa498ea8c63fe9">DbcTreeModel::headerData</a></div><div class="ttdeci">QVariant headerData(int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override</div><div class="ttdoc">Return horizontal display column titles.</div><div class="ttdef"><b>Definition</b> <a href="dbc__tree__model_8cpp_source.html#l00138">dbc_tree_model.cpp:138</a></div></div>
<div class="ttc" id="aclassDbcTreeModel_html_aca81d05c81cc48c1185fc36659e96e5b"><div class="ttname"><a href="classDbcTreeModel.html#aca81d05c81cc48c1185fc36659e96e5b">DbcTreeModel::data</a></div><div class="ttdeci">QVariant data(const QModelIndex &amp;index, int role=Qt::DisplayRole) const override</div><div class="ttdoc">Return display text or typed metadata for an index.</div><div class="ttdef"><b>Definition</b> <a href="dbc__tree__model_8cpp_source.html#l00074">dbc_tree_model.cpp:74</a></div></div>
<div class="ttc" id="aclassDbcTreeModel_html_ae40bb8b8a26d205f178c6dd1134ff4b3"><div class="ttname"><a href="classDbcTreeModel.html#ae40bb8b8a26d205f178c6dd1134ff4b3">DbcTreeModel::parent</a></div><div class="ttdeci">QModelIndex parent(const QModelIndex &amp;child) const override</div><div class="ttdoc">Return the parent in column zero, or an invalid index for frames.</div><div class="ttdef"><b>Definition</b> <a href="dbc__tree__model_8cpp_source.html#l00053">dbc_tree_model.cpp:53</a></div></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#l00037">tree_node.h:37</a></div></div>
<div class="ttc" id="adecode__database_8h_html_aaeb92d42f5a6e27b8ba19f18d69d142b"><div class="ttname"><a href="decode__database_8h.html#aaeb92d42f5a6e27b8ba19f18d69d142b">ByteOrder</a></div><div class="ttdeci">ByteOrder</div><div class="ttdoc">Signal byte order used for runtime decoding.</div><div class="ttdef"><b>Definition</b> <a href="decode__database_8h_source.html#l00028">decode_database.h:28</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">Qt-independent metadata tree nodes.</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->