tboudreaux/GridFire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(docs): rebuilt docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-11-24 09:08:28 -05:00
parent 9fab4fbfae
commit 22c0329de0
2410 changed files with 309008 additions and 146081 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/html/class_py_dynamic_engine_view.html
View File

@@ -120,16 +120,8 @@ Collaboration diagram for PyDynamicEngineView:</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a51680b135cfc3eea40daf9ef5aa903e0" id="r_a51680b135cfc3eea40daf9ef5aa903e0"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgridfire_1_1_dynamic_engine.html">gridfire::DynamicEngine</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a51680b135cfc3eea40daf9ef5aa903e0">getBaseEngine</a> () const override</td></tr>
<tr class="memdesc:a51680b135cfc3eea40daf9ef5aa903e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access the underlying engine instance. <br /></td></tr>
<tr class="memitem:a51680b135cfc3eea40daf9ef5aa903e0" id="r_a51680b135cfc3eea40daf9ef5aa903e0"><td class="memItemLeft" align="right" valign="top">const gridfire::DynamicEngine &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a51680b135cfc3eea40daf9ef5aa903e0">getBaseEngine</a> () const override</td></tr>
<tr class="separator:a51680b135cfc3eea40daf9ef5aa903e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_methods_classgridfire_1_1_engine_view"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classgridfire_1_1_engine_view')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgridfire_1_1_engine_view.html">gridfire::EngineView&lt; gridfire::DynamicEngine &gt;</a></td></tr>
<tr class="memitem:a994660f2d553f3a123512dc5eb421e74 inherit pub_methods_classgridfire_1_1_engine_view" id="r_a994660f2d553f3a123512dc5eb421e74"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1_engine_view.html#a994660f2d553f3a123512dc5eb421e74">~EngineView</a> ()=default</td></tr>
<tr class="memdesc:a994660f2d553f3a123512dc5eb421e74 inherit pub_methods_classgridfire_1_1_engine_view"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor. <br /></td></tr>
<tr class="separator:a994660f2d553f3a123512dc5eb421e74 inherit pub_methods_classgridfire_1_1_engine_view"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a51680b135cfc3eea40daf9ef5aa903e0" name="a51680b135cfc3eea40daf9ef5aa903e0"></a>
@@ -142,7 +134,7 @@ Additional Inherited Members</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classgridfire_1_1_dynamic_engine.html">gridfire::DynamicEngine</a> &amp; PyDynamicEngineView::getBaseEngine </td>
<td class="memname">const gridfire::DynamicEngine &amp; PyDynamicEngineView::getBaseEngine </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
@@ -150,18 +142,11 @@ Additional Inherited Members</h2></td></tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel private">private</span><span class="mlabel virtual">virtual</span></span> </td>
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel override">override</span><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Access the underlying engine instance. </p>
<dl class="section return"><dt>Returns</dt><dd>Const reference to the underlying engine.</dd></dl>
<p>This method must be implemented by derived classes to provide access to the base engine. The returned reference should remain valid for the lifetime of the EngineView.</p>
<p>Example: </p><div class="fragment"><div class="line"><span class="keyword">const</span> DynamicEngine&amp; engine = myView.getBaseEngine();</div>
</div><!-- fragment -->
<p>Implements <a class="el" href="classgridfire_1_1_engine_view.html#ad294227f8b5cf6d970c349eabf5447a6">gridfire::EngineView&lt; gridfire::DynamicEngine &gt;</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>