upfate doxygen
This commit is contained in:
1 parent
a55d1c58ed
commit
c43222939f
433 files changed
+15617
-7061
No files matched your search
@@ -125,13 +125,17 @@ Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:a9a3f8862ad7562e03e77b761eb94804c" id="r_a9a3f8862ad7562e03e77b761eb94804c"><td class="memItemLeft" align="right" valign="top"><a id="a9a3f8862ad7562e03e77b761eb94804c" name="a9a3f8862ad7562e03e77b761eb94804c"></a>
|
||||
<a class="el" href="classTreeNode.html">TreeNode</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classTreeNode.html">TreeNode</a> &&)=delete</td></tr>
|
||||
<tr class="separator:a9a3f8862ad7562e03e77b761eb94804c"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a6161f2ebb92184eab4215d121870e788" id="r_a6161f2ebb92184eab4215d121870e788"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTreeNode.html#a6161f2ebb92184eab4215d121870e788">AddChild</a> (std::unique_ptr< <a class="el" href="classTreeNode.html">TreeNode</a> > child)</td></tr>
|
||||
<tr class="memdesc:a6161f2ebb92184eab4215d121870e788"><td class="mdescLeft"> </td><td class="mdescRight">Add child node. <br /></td></tr>
|
||||
<tr class="separator:a6161f2ebb92184eab4215d121870e788"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:af87331684d4b40240aec75e3286921d3" id="r_af87331684d4b40240aec75e3286921d3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTreeNode.html#af87331684d4b40240aec75e3286921d3">AddChild</a> (std::unique_ptr< <a class="el" href="classTreeNode.html">TreeNode</a> > &&child)</td></tr>
|
||||
<tr class="memdesc:af87331684d4b40240aec75e3286921d3"><td class="mdescLeft"> </td><td class="mdescRight">Add child node. <br /></td></tr>
|
||||
<tr class="separator:af87331684d4b40240aec75e3286921d3"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aa48fbc17903eb8cfa40353e29f853c6f" id="r_aa48fbc17903eb8cfa40353e29f853c6f"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classTreeNode.html">TreeNode</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTreeNode.html#aa48fbc17903eb8cfa40353e29f853c6f">GetParent</a> () const</td></tr>
|
||||
<tr class="separator:aa48fbc17903eb8cfa40353e29f853c6f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ad501f97eeec7f7d3353bfae838fbb6a8" id="r_ad501f97eeec7f7d3353bfae838fbb6a8"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTreeNode.html#ad501f97eeec7f7d3353bfae838fbb6a8">GetRow</a> () const</td></tr>
|
||||
<tr class="separator:ad501f97eeec7f7d3353bfae838fbb6a8"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:af4e6e916c48c024a3dfeadac8174b527" id="r_af4e6e916c48c024a3dfeadac8174b527"><td class="memItemLeft" align="right" valign="top">std::optional< <a class="el" href="structFrameKey.html">FrameKey</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classTreeNode.html#af4e6e916c48c024a3dfeadac8174b527">GetFrameKey</a> () const</td></tr>
|
||||
<tr class="separator:af4e6e916c48c024a3dfeadac8174b527"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a1eb94f7b6e7962c9d867a120772dfe6e" id="r_a1eb94f7b6e7962c9d867a120772dfe6e"><td class="memItemLeft" align="right" valign="top">std::optional< <a class="el" href="structSignalKey.html">SignalKey</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classTreeNode.html#a1eb94f7b6e7962c9d867a120772dfe6e">GetSignalKey</a> () const</td></tr>
|
||||
<tr class="separator:a1eb94f7b6e7962c9d867a120772dfe6e"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:abdd82460187dca8d3e5d66f5d5c529ea" id="r_abdd82460187dca8d3e5d66f5d5c529ea"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTreeNode.html#abdd82460187dca8d3e5d66f5d5c529ea">GetChildCount</a> () const</td></tr>
|
||||
<tr class="memdesc:abdd82460187dca8d3e5d66f5d5c529ea"><td class="mdescLeft"> </td><td class="mdescRight">Get child count. <br /></td></tr>
|
||||
<tr class="separator:abdd82460187dca8d3e5d66f5d5c529ea"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
@@ -157,7 +161,7 @@ Public Member Functions</h2></td></tr>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Tree node for later use in model/view or other hierarchy consumers. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8h_source.html#l00035">35</a> of file <a class="el" href="tree__node_8h_source.html">tree_node.h</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8h_source.html#l00037">37</a> of file <a class="el" href="tree__node_8h_source.html">tree_node.h</a>.</p>
|
||||
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||||
<a id="a984a98d5ccf7ef1f5a18094c6821f35d" name="a984a98d5ccf7ef1f5a18094c6821f35d"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a984a98d5ccf7ef1f5a18094c6821f35d">◆ </a></span>TreeNode() <span class="overload">[1/3]</span></h2>
|
||||
@@ -176,7 +180,7 @@ Public Member Functions</h2></td></tr>
|
||||
|
||||
<p>Create root node. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00014">14</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00015">15</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -212,7 +216,7 @@ Public Member Functions</h2></td></tr>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00018">18</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00019">19</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -248,13 +252,13 @@ Public Member Functions</h2></td></tr>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00022">22</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00023">23</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Member Function Documentation</h2>
|
||||
<a id="a6161f2ebb92184eab4215d121870e788" name="a6161f2ebb92184eab4215d121870e788"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a6161f2ebb92184eab4215d121870e788">◆ </a></span>AddChild()</h2>
|
||||
<a id="af87331684d4b40240aec75e3286921d3" name="af87331684d4b40240aec75e3286921d3"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#af87331684d4b40240aec75e3286921d3">◆ </a></span>AddChild()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
@@ -262,7 +266,7 @@ Public Member Functions</h2></td></tr>
|
||||
<tr>
|
||||
<td class="memname">void TreeNode::AddChild </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">std::unique_ptr< <a class="el" href="classTreeNode.html">TreeNode</a> > </td>
|
||||
<td class="paramtype">std::unique_ptr< <a class="el" href="classTreeNode.html">TreeNode</a> > && </td>
|
||||
<td class="paramname"><em>child</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
@@ -272,12 +276,18 @@ Public Member Functions</h2></td></tr>
|
||||
<p>Add child node. </p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">child</td><td>Child node to add. </td></tr>
|
||||
<tr><td class="paramname">child</td><td>Child node to add. A null child is ignored. Existing children keep their addresses and rows. Ownership must be exclusive; attached nodes cannot be reparented. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="exception"><dt>Exceptions</dt><dd>
|
||||
<table class="exception">
|
||||
<tr><td class="paramname">std::invalid_argument</td><td>for self/ancestor insertion or an attached child. Rejected ownership remains with the caller. </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00026">26</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00027">27</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -297,7 +307,9 @@ Public Member Functions</h2></td></tr>
|
||||
</div><div class="memdoc">
|
||||
<p>Non-owning parent; nullptr for a detached node or the root. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00068">68</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00075">75</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
<p class="reference">Referenced by <a class="el" href="dbc__tree__model_8cpp_source.html#l00053">DbcTreeModel::parent()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -317,7 +329,55 @@ Public Member Functions</h2></td></tr>
|
||||
</div><div class="memdoc">
|
||||
<p>Zero-based sibling position; zero for a detached node or the root. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00072">72</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00079">79</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
<p class="reference">Referenced by <a class="el" href="dbc__tree__model_8cpp_source.html#l00053">DbcTreeModel::parent()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="af4e6e916c48c024a3dfeadac8174b527" name="af4e6e916c48c024a3dfeadac8174b527"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#af4e6e916c48c024a3dfeadac8174b527">◆ </a></span>GetFrameKey()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">std::optional< <a class="el" href="structFrameKey.html">FrameKey</a> > TreeNode::GetFrameKey </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td> const</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Frame identity for frame nodes and signals attached to a frame; otherwise empty. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00083">83</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
<p class="reference">References <a class="el" href="tree__node_8cpp_source.html#l00083">GetFrameKey()</a>, and <a class="el" href="tree__node_8cpp_source.html#l00059">GetType()</a>.</p>
|
||||
|
||||
<p class="reference">Referenced by <a class="el" href="tree__node_8cpp_source.html#l00083">GetFrameKey()</a>, and <a class="el" href="tree__node_8cpp_source.html#l00091">GetSignalKey()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a1eb94f7b6e7962c9d867a120772dfe6e" name="a1eb94f7b6e7962c9d867a120772dfe6e"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a1eb94f7b6e7962c9d867a120772dfe6e">◆ </a></span>GetSignalKey()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">std::optional< <a class="el" href="structSignalKey.html">SignalKey</a> > TreeNode::GetSignalKey </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td> const</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Signal identity (owning frame key and name); empty for other/detached nodes. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00091">91</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
<p class="reference">References <a class="el" href="tree__node_8cpp_source.html#l00083">GetFrameKey()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -339,7 +399,9 @@ Public Member Functions</h2></td></tr>
|
||||
<p>Get child count. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>Number of children. </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00034">34</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00041">41</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
<p class="reference">Referenced by <a class="el" href="dbc__tree__model_8cpp_source.html#l00061">DbcTreeModel::rowCount()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -368,7 +430,9 @@ Public Member Functions</h2></td></tr>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>Child pointer or nullptr if index is invalid. </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00038">38</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00045">45</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
<p class="reference">Referenced by <a class="el" href="dbc__tree__model_8cpp_source.html#l00042">DbcTreeModel::index()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -397,7 +461,7 @@ Public Member Functions</h2></td></tr>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>Child pointer or nullptr if index is invalid. </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00045">45</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00052">52</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -419,7 +483,9 @@ Public Member Functions</h2></td></tr>
|
||||
<p>Get node type. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>Node type. </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00052">52</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00059">59</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
<p class="reference">Referenced by <a class="el" href="dbc__tree__model_8cpp_source.html#l00074">DbcTreeModel::data()</a>, and <a class="el" href="tree__node_8cpp_source.html#l00083">GetFrameKey()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -441,7 +507,9 @@ Public Member Functions</h2></td></tr>
|
||||
<p>Get display name. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>Node name. </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00056">56</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00063">63</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
<p class="reference">Referenced by <a class="el" href="dbc__tree__model_8cpp_source.html#l00074">DbcTreeModel::data()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -463,7 +531,9 @@ Public Member Functions</h2></td></tr>
|
||||
<p>Get frame payload if node is frame. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>Pointer to frame info or nullptr. </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00060">60</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00067">67</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
<p class="reference">Referenced by <a class="el" href="dbc__tree__model_8cpp_source.html#l00074">DbcTreeModel::data()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -485,7 +555,9 @@ Public Member Functions</h2></td></tr>
|
||||
<p>Get signal payload if node is signal. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>Pointer to signal info or nullptr. </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00064">64</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00071">71</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
<p class="reference">Referenced by <a class="el" href="dbc__tree__model_8cpp_source.html#l00074">DbcTreeModel::data()</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in new issue
Block a user