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

docs(docs): rebuilt for version v0.7.1_rc2

Browse Source
This commit is contained in:
Emily M. Boudreaux
2025-11-28 09:46:00 -05:00
parent 033c5a083d
commit a472dc5214
2480 changed files with 231104 additions and 76191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
docs/html/namespacegridfire_1_1trigger.html
View File

@@ -3,18 +3,16 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GridFire: gridfire::trigger Namespace Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
@@ -29,7 +27,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">GridFire<span id="projectnumber">&#160;v0.7.0_rc2</span>
<div id="projectname">GridFire<span id="projectnumber">&#160;v0.7.1_rc2</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
@@ -38,24 +36,19 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
@@ -73,7 +66,7 @@ $(function() {
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('namespacegridfire_1_1trigger.html',''); initResizable(true); });
$(document).ready(function(){initNavTree('namespacegridfire_1_1trigger.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
@@ -109,35 +102,35 @@ $(function(){initNavTree('namespacegridfire_1_1trigger.html',''); initResizable(
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1trigger_1_1solver.html">solver</a></td></tr>
<tr class="memitem:namespacegridfire_1_1trigger_1_1solver" id="r_namespacegridfire_1_1trigger_1_1solver"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1trigger_1_1solver.html">solver</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1_and_trigger.html">AndTrigger</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Logical conjunction of two triggers with short-circuit evaluation. <a href="classgridfire_1_1trigger_1_1_and_trigger.html#details">More...</a><br /></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1AndTrigger.html">AndTrigger</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Logical conjunction of two triggers with short-circuit evaluation. <a href="classgridfire_1_1trigger_1_1AndTrigger.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1_every_nth_trigger.html">EveryNthTrigger</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pass-through trigger that fires every Nth time its child trigger is true. <a href="classgridfire_1_1trigger_1_1_every_nth_trigger.html#details">More...</a><br /></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1EveryNthTrigger.html">EveryNthTrigger</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pass-through trigger that fires every Nth time its child trigger is true. <a href="classgridfire_1_1trigger_1_1EveryNthTrigger.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1_logical_trigger.html">LogicalTrigger</a></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1LogicalTrigger.html">LogicalTrigger</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1_not_trigger.html">NotTrigger</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Logical negation of a trigger. <a href="classgridfire_1_1trigger_1_1_not_trigger.html#details">More...</a><br /></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1NotTrigger.html">NotTrigger</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Logical negation of a trigger. <a href="classgridfire_1_1trigger_1_1NotTrigger.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1_or_trigger.html">OrTrigger</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Logical disjunction of two triggers with short-circuit evaluation. <a href="classgridfire_1_1trigger_1_1_or_trigger.html#details">More...</a><br /></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html">OrTrigger</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Logical disjunction of two triggers with short-circuit evaluation. <a href="classgridfire_1_1trigger_1_1OrTrigger.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1_trigger.html">Trigger</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generic trigger interface for signaling events/conditions during integration. <a href="classgridfire_1_1trigger_1_1_trigger.html#details">More...</a><br /></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1Trigger.html">Trigger</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generic trigger interface for signaling events/conditions during integration. <a href="classgridfire_1_1trigger_1_1Trigger.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1trigger_1_1_trigger_result.html">TriggerResult</a></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgridfire_1_1trigger_1_1TriggerResult.html">TriggerResult</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a5e0fe21f3356426f26b109cdeb1edcd9" id="r_a5e0fe21f3356426f26b109cdeb1edcd9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5e0fe21f3356426f26b109cdeb1edcd9">printWhy</a> (const <a class="el" href="structgridfire_1_1trigger_1_1_trigger_result.html">TriggerResult</a> &amp;result, const int indent=0)</td></tr>
<tr class="memdesc:a5e0fe21f3356426f26b109cdeb1edcd9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pretty-print a <a class="el" href="structgridfire_1_1trigger_1_1_trigger_result.html">TriggerResult</a> explanation tree to std::cout. <br /></td></tr>
<tr class="memitem:a5e0fe21f3356426f26b109cdeb1edcd9" id="r_a5e0fe21f3356426f26b109cdeb1edcd9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegridfire_1_1trigger.html#a5e0fe21f3356426f26b109cdeb1edcd9">printWhy</a> (const <a class="el" href="structgridfire_1_1trigger_1_1TriggerResult.html">TriggerResult</a> &amp;result, const int indent=0)</td></tr>
<tr class="memdesc:a5e0fe21f3356426f26b109cdeb1edcd9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pretty-print a <a class="el" href="structgridfire_1_1trigger_1_1TriggerResult.html">TriggerResult</a> explanation tree to std::cout. <br /></td></tr>
<tr class="separator:a5e0fe21f3356426f26b109cdeb1edcd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
@@ -153,36 +146,43 @@ Functions</h2></td></tr>
<tr>
<td class="memname">void gridfire::trigger::printWhy </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structgridfire_1_1trigger_1_1_trigger_result.html">TriggerResult</a> &amp;</td> <td class="paramname"><span class="paramname"><em>result</em></span>, </td>
<td class="paramtype">const <a class="el" href="structgridfire_1_1trigger_1_1TriggerResult.html">TriggerResult</a> &amp;&#160;</td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int</td> <td class="paramname"><span class="paramname"><em>indent</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span>&#160;)</td>
<td class="paramtype">const int&#160;</td>
<td class="paramname"><em>indent</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Pretty-print a <a class="el" href="structgridfire_1_1trigger_1_1_trigger_result.html">TriggerResult</a> explanation tree to std::cout. </p>
<p>Pretty-print a <a class="el" href="structgridfire_1_1trigger_1_1TriggerResult.html">TriggerResult</a> explanation tree to std::cout. </p>
<p>Prints one line per node prefixed with Unicode bullets and indentation to visualize the explanation hierarchy. Each line shows [TRUE|FALSE], the node name, and description.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">result</td><td>Root <a class="el" href="structgridfire_1_1trigger_1_1_trigger_result.html">TriggerResult</a> to print. </td></tr>
<tr><td class="paramname">result</td><td>Root <a class="el" href="structgridfire_1_1trigger_1_1TriggerResult.html">TriggerResult</a> to print. </td></tr>
<tr><td class="paramname">indent</td><td>Current indentation level (number of two-space indents); callers typically omit this parameter and let recursion handle it.</td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="keyword">using </span><a class="code hl_struct" href="structgridfire_1_1trigger_1_1_trigger_result.html">gridfire::trigger::TriggerResult</a>;</div>
<div class="line"><a class="code hl_struct" href="structgridfire_1_1trigger_1_1_trigger_result.html">TriggerResult</a> leaf{<span class="stringliteral">&quot;A&gt;5&quot;</span>, <span class="stringliteral">&quot;Threshold passed&quot;</span>, <span class="keyword">true</span>, {}};</div>
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="keyword">using </span><a class="code hl_struct" href="structgridfire_1_1trigger_1_1TriggerResult.html">gridfire::trigger::TriggerResult</a>;</div>
<div class="line"><a class="code hl_struct" href="structgridfire_1_1trigger_1_1TriggerResult.html">TriggerResult</a> leaf{<span class="stringliteral">&quot;A&gt;5&quot;</span>, <span class="stringliteral">&quot;Threshold passed&quot;</span>, <span class="keyword">true</span>, {}};</div>
<div class="line">TriggerResult root{<span class="stringliteral">&quot;AND&quot;</span>, <span class="stringliteral">&quot;Both conditions true&quot;</span>, <span class="keyword">true</span>, {leaf}};</div>
<div class="line"><a class="code hl_function" href="#a5e0fe21f3356426f26b109cdeb1edcd9">gridfire::trigger::printWhy</a>(root);</div>
<div class="ttc" id="anamespacegridfire_1_1trigger_html_a5e0fe21f3356426f26b109cdeb1edcd9"><div class="ttname"><a href="#a5e0fe21f3356426f26b109cdeb1edcd9">gridfire::trigger::printWhy</a></div><div class="ttdeci">void printWhy(const TriggerResult &amp;result, const int indent=0)</div><div class="ttdoc">Pretty-print a TriggerResult explanation tree to std::cout.</div><div class="ttdef"><b>Definition</b> trigger_pprint.h:26</div></div>
<div class="ttc" id="astructgridfire_1_1trigger_1_1_trigger_result_html"><div class="ttname"><a href="structgridfire_1_1trigger_1_1_trigger_result.html">gridfire::trigger::TriggerResult</a></div><div class="ttdef"><b>Definition</b> trigger_result.h:23</div></div>
<div class="line"><a class="code hl_function" href="namespacegridfire_1_1trigger.html#a5e0fe21f3356426f26b109cdeb1edcd9">gridfire::trigger::printWhy</a>(root);</div>
<div class="ttc" id="anamespacegridfire_1_1trigger_html_a5e0fe21f3356426f26b109cdeb1edcd9"><div class="ttname"><a href="namespacegridfire_1_1trigger.html#a5e0fe21f3356426f26b109cdeb1edcd9">gridfire::trigger::printWhy</a></div><div class="ttdeci">void printWhy(const TriggerResult &amp;result, const int indent=0)</div><div class="ttdoc">Pretty-print a TriggerResult explanation tree to std::cout.</div><div class="ttdef"><b>Definition</b> trigger_pprint.h:26</div></div>
<div class="ttc" id="astructgridfire_1_1trigger_1_1TriggerResult_html"><div class="ttname"><a href="structgridfire_1_1trigger_1_1TriggerResult.html">gridfire::trigger::TriggerResult</a></div><div class="ttdef"><b>Definition</b> trigger_result.h:23</div></div>
</div><!-- fragment --> </dd></dl>
</div>
@@ -193,7 +193,7 @@ Functions</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacegridfire.html">gridfire</a></li><li class="navelem"><a class="el" href="namespacegridfire_1_1trigger.html">trigger</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>