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

docs(docs): rebuilt

Browse Source
This commit is contained in:
Emily Boudreaux
2025-11-25 14:31:59 -05:00
parent b0c68a709f
commit 2eebbf6819
1514 changed files with 83712 additions and 57694 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
docs/html/class_py_engine_view.html
View File

@@ -29,7 +29,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">GridFire<span id="projectnumber">&#160;v0.7.0-alpha</span>
<div id="projectname">GridFire<span id="projectnumber">&#160;v0.7.0_rc1</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
@@ -110,22 +110,30 @@ $(function(){initNavTree('class_py_engine_view.html',''); initResizable(true); }
<div class="dynheader">
Inheritance diagram for PyEngineView:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="class_py_engine_view__inherit__graph.svg" width="148" height="126"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<div class="center"><iframe scrolling="no" frameborder="0" src="class_py_engine_view__inherit__graph.svg" width="166" height="140"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for PyEngineView:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="class_py_engine_view__coll__graph.svg" width="148" height="126"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<div class="center"><iframe scrolling="no" frameborder="0" src="class_py_engine_view__coll__graph.svg" width="166" height="140"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></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:a3cd83dc57b521c65a14edf70357a8845" id="r_a3cd83dc57b521c65a14edf70357a8845"><td class="memItemLeft" align="right" valign="top">const gridfire::Engine &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3cd83dc57b521c65a14edf70357a8845">getBaseEngine</a> () const override</td></tr>
<tr class="separator:a3cd83dc57b521c65a14edf70357a8845"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea9da2bcfdf25f3d17d007091eece206" id="r_aea9da2bcfdf25f3d17d007091eece206"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgridfire_1_1engine_1_1_engine.html">gridfire::engine::Engine</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aea9da2bcfdf25f3d17d007091eece206">getBaseEngine</a> () const override</td></tr>
<tr class="memdesc:aea9da2bcfdf25f3d17d007091eece206"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access the underlying engine instance. <br /></td></tr>
<tr class="separator:aea9da2bcfdf25f3d17d007091eece206"><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_1engine_1_1_engine_view"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classgridfire_1_1engine_1_1_engine_view')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgridfire_1_1engine_1_1_engine_view.html">gridfire::engine::EngineView&lt; gridfire::engine::Engine &gt;</a></td></tr>
<tr class="memitem:a17d63e853d6efca31064e9147c80d497 inherit pub_methods_classgridfire_1_1engine_1_1_engine_view" id="r_a17d63e853d6efca31064e9147c80d497"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1engine_1_1_engine_view.html#a17d63e853d6efca31064e9147c80d497">~EngineView</a> ()=default</td></tr>
<tr class="memdesc:a17d63e853d6efca31064e9147c80d497 inherit pub_methods_classgridfire_1_1engine_1_1_engine_view"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor. <br /></td></tr>
<tr class="separator:a17d63e853d6efca31064e9147c80d497 inherit pub_methods_classgridfire_1_1engine_1_1_engine_view"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3cd83dc57b521c65a14edf70357a8845" name="a3cd83dc57b521c65a14edf70357a8845"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3cd83dc57b521c65a14edf70357a8845">&#9670;&#160;</a></span>getBaseEngine()</h2>
<a id="aea9da2bcfdf25f3d17d007091eece206" name="aea9da2bcfdf25f3d17d007091eece206"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea9da2bcfdf25f3d17d007091eece206">&#9670;&#160;</a></span>getBaseEngine()</h2>
<div class="memitem">
<div class="memproto">
@@ -134,7 +142,7 @@ Private Member Functions</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const gridfire::Engine &amp; PyEngineView::getBaseEngine </td>
<td class="memname">const <a class="el" href="classgridfire_1_1engine_1_1_engine.html">gridfire::engine::Engine</a> &amp; PyEngineView::getBaseEngine </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
@@ -142,11 +150,18 @@ Private Member Functions</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> </td>
<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>
</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_1engine_1_1_engine_view.html#a7884ea8e5618e295e64150f3ecf2c6b5">gridfire::engine::EngineView&lt; gridfire::engine::Engine &gt;</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>