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

727
docs/html/classgridfire_1_1trigger_1_1OrTrigger.html Normal file
View File

@@ -0,0 +1,727 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GridFire: gridfire::trigger::OrTrigger&lt; TriggerContextStruct &gt; Class Template 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>
<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>
<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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">GridFire<span id="projectnumber">&#160;v0.7.1_rc2</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- 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" 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');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classgridfire_1_1trigger_1_1OrTrigger.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classgridfire_1_1trigger_1_1OrTrigger-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">gridfire::trigger::OrTrigger&lt; TriggerContextStruct &gt; Class Template Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Logical disjunction of two triggers with short-circuit evaluation.
<a href="classgridfire_1_1trigger_1_1OrTrigger.html#details">More...</a></p>
<p><code>#include &lt;trigger_logical.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for gridfire::trigger::OrTrigger&lt; TriggerContextStruct &gt;:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1trigger_1_1OrTrigger__inherit__graph.svg" width="255" height="242"><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 gridfire::trigger::OrTrigger&lt; TriggerContextStruct &gt;:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1trigger_1_1OrTrigger__coll__graph.svg" width="100%" height="408"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></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="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aaf4f8a090bdd10eeba0b7849fa8ed888" id="r_aaf4f8a090bdd10eeba0b7849fa8ed888"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html#aaf4f8a090bdd10eeba0b7849fa8ed888">OrTrigger</a> (std::unique_ptr&lt; <a class="el" href="classgridfire_1_1trigger_1_1Trigger.html">Trigger</a>&lt; TriggerContextStruct &gt; &gt; A, std::unique_ptr&lt; <a class="el" href="classgridfire_1_1trigger_1_1Trigger.html">Trigger</a>&lt; TriggerContextStruct &gt; &gt; B)</td></tr>
<tr class="separator:aaf4f8a090bdd10eeba0b7849fa8ed888"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe30f95de39c1375557d032b8a8111f9" id="r_afe30f95de39c1375557d032b8a8111f9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html#afe30f95de39c1375557d032b8a8111f9">~OrTrigger</a> () override=default</td></tr>
<tr class="separator:afe30f95de39c1375557d032b8a8111f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8be54d91e77ed16ae3cca2417d82e0a" id="r_ac8be54d91e77ed16ae3cca2417d82e0a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html#ac8be54d91e77ed16ae3cca2417d82e0a">check</a> (const TriggerContextStruct &amp;ctx) const override</td></tr>
<tr class="memdesc:ac8be54d91e77ed16ae3cca2417d82e0a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Evaluate the trigger condition against the provided context. <br /></td></tr>
<tr class="separator:ac8be54d91e77ed16ae3cca2417d82e0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a775dac97d109c5fcd5c0287ca98f308c" id="r_a775dac97d109c5fcd5c0287ca98f308c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html#a775dac97d109c5fcd5c0287ca98f308c">update</a> (const TriggerContextStruct &amp;ctx) override</td></tr>
<tr class="memdesc:a775dac97d109c5fcd5c0287ca98f308c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update any internal state with the given context (e.g., counters, windows). <br /></td></tr>
<tr class="separator:a775dac97d109c5fcd5c0287ca98f308c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95a801aafb5aaa9a22566ebf722a1150" id="r_a95a801aafb5aaa9a22566ebf722a1150"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html#a95a801aafb5aaa9a22566ebf722a1150">step</a> (const TriggerContextStruct &amp;ctx) override</td></tr>
<tr class="memdesc:a95a801aafb5aaa9a22566ebf722a1150"><td class="mdescLeft">&#160;</td><td class="mdescRight">similar to update but intended to be run on every step not just those where the trigger triggered <br /></td></tr>
<tr class="separator:a95a801aafb5aaa9a22566ebf722a1150"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab42043e55c81bac5d3f981bc139579de" id="r_ab42043e55c81bac5d3f981bc139579de"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html#ab42043e55c81bac5d3f981bc139579de">reset</a> () override</td></tr>
<tr class="memdesc:ab42043e55c81bac5d3f981bc139579de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset internal state and diagnostics counters. <br /></td></tr>
<tr class="separator:ab42043e55c81bac5d3f981bc139579de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a062af4f567dc48c088f1fcfb64cc79ec" id="r_a062af4f567dc48c088f1fcfb64cc79ec"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html#a062af4f567dc48c088f1fcfb64cc79ec">name</a> () const override</td></tr>
<tr class="memdesc:a062af4f567dc48c088f1fcfb64cc79ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Short, stable name for this trigger (suitable for logs/UI). <br /></td></tr>
<tr class="separator:a062af4f567dc48c088f1fcfb64cc79ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7bca0da16353f4b04a2f40fb29c07922" id="r_a7bca0da16353f4b04a2f40fb29c07922"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgridfire_1_1trigger_1_1TriggerResult.html">TriggerResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html#a7bca0da16353f4b04a2f40fb29c07922">why</a> (const TriggerContextStruct &amp;ctx) const override</td></tr>
<tr class="memdesc:a7bca0da16353f4b04a2f40fb29c07922"><td class="mdescLeft">&#160;</td><td class="mdescRight">Explain why the last evaluation would be true/false in a structured way. <br /></td></tr>
<tr class="separator:a7bca0da16353f4b04a2f40fb29c07922"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:accb56630df2f57400467d315c61dede6" id="r_accb56630df2f57400467d315c61dede6"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html#accb56630df2f57400467d315c61dede6">describe</a> () const override</td></tr>
<tr class="memdesc:accb56630df2f57400467d315c61dede6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable description of this trigger's logic. <br /></td></tr>
<tr class="separator:accb56630df2f57400467d315c61dede6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc7d3eae8306ee383d76997ac3803327" id="r_afc7d3eae8306ee383d76997ac3803327"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html#afc7d3eae8306ee383d76997ac3803327">numTriggers</a> () const override</td></tr>
<tr class="memdesc:afc7d3eae8306ee383d76997ac3803327"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total number of times this trigger evaluated to true since last reset. <br /></td></tr>
<tr class="separator:afc7d3eae8306ee383d76997ac3803327"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b3a7f45604dbb27e832d9559dd20997" id="r_a0b3a7f45604dbb27e832d9559dd20997"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html#a0b3a7f45604dbb27e832d9559dd20997">numMisses</a> () const override</td></tr>
<tr class="memdesc:a0b3a7f45604dbb27e832d9559dd20997"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total number of times this trigger evaluated to false since last reset. <br /></td></tr>
<tr class="separator:a0b3a7f45604dbb27e832d9559dd20997"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgridfire_1_1trigger_1_1Trigger"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgridfire_1_1trigger_1_1Trigger')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgridfire_1_1trigger_1_1Trigger.html">gridfire::trigger::Trigger&lt; TriggerContextStruct &gt;</a></td></tr>
<tr class="memitem:a2c077ccbaf4de9f7068e50144391edda inherit pub_methods_classgridfire_1_1trigger_1_1Trigger" id="r_a2c077ccbaf4de9f7068e50144391edda"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1Trigger.html#a2c077ccbaf4de9f7068e50144391edda">~Trigger</a> ()=default</td></tr>
<tr class="memdesc:a2c077ccbaf4de9f7068e50144391edda inherit pub_methods_classgridfire_1_1trigger_1_1Trigger"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor for polymorphic use. <br /></td></tr>
<tr class="separator:a2c077ccbaf4de9f7068e50144391edda inherit pub_methods_classgridfire_1_1trigger_1_1Trigger"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a6da04b5b15371f7087be03bb337dbdd6" id="r_a6da04b5b15371f7087be03bb337dbdd6"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classgridfire_1_1trigger_1_1Trigger.html">Trigger</a>&lt; TriggerContextStruct &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html#a6da04b5b15371f7087be03bb337dbdd6">m_A</a></td></tr>
<tr class="separator:a6da04b5b15371f7087be03bb337dbdd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30dec370b61a5f0562956394b89e8f89" id="r_a30dec370b61a5f0562956394b89e8f89"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classgridfire_1_1trigger_1_1Trigger.html">Trigger</a>&lt; TriggerContextStruct &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html#a30dec370b61a5f0562956394b89e8f89">m_B</a></td></tr>
<tr class="separator:a30dec370b61a5f0562956394b89e8f89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35d519d5266c68b696b779b275574ebf" id="r_a35d519d5266c68b696b779b275574ebf"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html#a35d519d5266c68b696b779b275574ebf">m_hits</a> = 0</td></tr>
<tr class="separator:a35d519d5266c68b696b779b275574ebf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae72e6e9f1fbfbd11fbfe9aa6d4ff5a3b" id="r_ae72e6e9f1fbfbd11fbfe9aa6d4ff5a3b"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html#ae72e6e9f1fbfbd11fbfe9aa6d4ff5a3b">m_misses</a> = 0</td></tr>
<tr class="separator:ae72e6e9f1fbfbd11fbfe9aa6d4ff5a3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af595a5daab0f5b3ffc450c6de6737517" id="r_af595a5daab0f5b3ffc450c6de6737517"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html#af595a5daab0f5b3ffc450c6de6737517">m_updates</a> = 0</td></tr>
<tr class="separator:af595a5daab0f5b3ffc450c6de6737517"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc6f560d9199455ba98d85eadfe02847" id="r_adc6f560d9199455ba98d85eadfe02847"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html#adc6f560d9199455ba98d85eadfe02847">m_resets</a> = 0</td></tr>
<tr class="separator:adc6f560d9199455ba98d85eadfe02847"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a596db4a92ebf789cea1c431d3d2220c7" id="r_a596db4a92ebf789cea1c431d3d2220c7"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html#a596db4a92ebf789cea1c431d3d2220c7">m_steps</a> = 0</td></tr>
<tr class="separator:a596db4a92ebf789cea1c431d3d2220c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename TriggerContextStruct&gt;<br />
class gridfire::trigger::OrTrigger&lt; TriggerContextStruct &gt;</div><p>Logical disjunction of two triggers with short-circuit evaluation. </p>
<p>check(ctx) returns A.check(ctx) || B.check(ctx). why(ctx) returns early when A is true. update(ctx) calls <a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html#a775dac97d109c5fcd5c0287ca98f308c" title="Update any internal state with the given context (e.g., counters, windows).">update()</a> on both A and B. Counters behave as in <a class="el" href="classgridfire_1_1trigger_1_1AndTrigger.html" title="Logical conjunction of two triggers with short-circuit evaluation.">AndTrigger</a>. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aaf4f8a090bdd10eeba0b7849fa8ed888" name="aaf4f8a090bdd10eeba0b7849fa8ed888"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf4f8a090bdd10eeba0b7849fa8ed888">&#9670;&#160;</a></span>OrTrigger()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html">gridfire::trigger::OrTrigger</a>&lt; TriggerContextStruct &gt;::OrTrigger </td>
<td>(</td>
<td class="paramtype">std::unique_ptr&lt; <a class="el" href="classgridfire_1_1trigger_1_1Trigger.html">Trigger</a>&lt; TriggerContextStruct &gt; &gt;&#160;</td>
<td class="paramname"><em>A</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::unique_ptr&lt; <a class="el" href="classgridfire_1_1trigger_1_1Trigger.html">Trigger</a>&lt; TriggerContextStruct &gt; &gt;&#160;</td>
<td class="paramname"><em>B</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="afe30f95de39c1375557d032b8a8111f9" name="afe30f95de39c1375557d032b8a8111f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe30f95de39c1375557d032b8a8111f9">&#9670;&#160;</a></span>~OrTrigger()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html">gridfire::trigger::OrTrigger</a>&lt; TriggerContextStruct &gt;::~<a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html">OrTrigger</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac8be54d91e77ed16ae3cca2417d82e0a" name="ac8be54d91e77ed16ae3cca2417d82e0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8be54d91e77ed16ae3cca2417d82e0a">&#9670;&#160;</a></span>check()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html">gridfire::trigger::OrTrigger</a>&lt; TriggerContextStruct &gt;::check </td>
<td>(</td>
<td class="paramtype">const TriggerContextStruct &amp;&#160;</td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Evaluate the trigger condition against the provided context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>Context snapshot (immutable view) used to evaluate the condition. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the condition is satisfied; false otherwise. </dd></dl>
<p>Implements <a class="el" href="classgridfire_1_1trigger_1_1Trigger.html#a1579ffb1c841cda4e67990b42d400d88">gridfire::trigger::Trigger&lt; TriggerContextStruct &gt;</a>.</p>
</div>
</div>
<a id="accb56630df2f57400467d315c61dede6" name="accb56630df2f57400467d315c61dede6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#accb56630df2f57400467d315c61dede6">&#9670;&#160;</a></span>describe()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string <a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html">gridfire::trigger::OrTrigger</a>&lt; TriggerContextStruct &gt;::describe </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Human-readable description of this trigger's logic. </p>
<p>Implements <a class="el" href="classgridfire_1_1trigger_1_1Trigger.html#a402cdd062e9479abbcca02e3d94e528f">gridfire::trigger::Trigger&lt; TriggerContextStruct &gt;</a>.</p>
</div>
</div>
<a id="a062af4f567dc48c088f1fcfb64cc79ec" name="a062af4f567dc48c088f1fcfb64cc79ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a062af4f567dc48c088f1fcfb64cc79ec">&#9670;&#160;</a></span>name()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string <a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html">gridfire::trigger::OrTrigger</a>&lt; TriggerContextStruct &gt;::name </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Short, stable name for this trigger (suitable for logs/UI). </p>
<p>Implements <a class="el" href="classgridfire_1_1trigger_1_1Trigger.html#a3e5b017147f22ca0733733cd39e334b7">gridfire::trigger::Trigger&lt; TriggerContextStruct &gt;</a>.</p>
</div>
</div>
<a id="a0b3a7f45604dbb27e832d9559dd20997" name="a0b3a7f45604dbb27e832d9559dd20997"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b3a7f45604dbb27e832d9559dd20997">&#9670;&#160;</a></span>numMisses()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html">gridfire::trigger::OrTrigger</a>&lt; TriggerContextStruct &gt;::numMisses </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Total number of times this trigger evaluated to false since last reset. </p>
<p>Implements <a class="el" href="classgridfire_1_1trigger_1_1Trigger.html#a81848e5af844795d879b6d885a2701d7">gridfire::trigger::Trigger&lt; TriggerContextStruct &gt;</a>.</p>
</div>
</div>
<a id="afc7d3eae8306ee383d76997ac3803327" name="afc7d3eae8306ee383d76997ac3803327"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc7d3eae8306ee383d76997ac3803327">&#9670;&#160;</a></span>numTriggers()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html">gridfire::trigger::OrTrigger</a>&lt; TriggerContextStruct &gt;::numTriggers </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Total number of times this trigger evaluated to true since last reset. </p>
<p>Implements <a class="el" href="classgridfire_1_1trigger_1_1Trigger.html#a4ea3abfb76a09c4f55ad05d73a2cf12d">gridfire::trigger::Trigger&lt; TriggerContextStruct &gt;</a>.</p>
</div>
</div>
<a id="ab42043e55c81bac5d3f981bc139579de" name="ab42043e55c81bac5d3f981bc139579de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab42043e55c81bac5d3f981bc139579de">&#9670;&#160;</a></span>reset()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html">gridfire::trigger::OrTrigger</a>&lt; TriggerContextStruct &gt;::reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset internal state and diagnostics counters. </p>
<p>Implements <a class="el" href="classgridfire_1_1trigger_1_1Trigger.html#af652af761675736419b961b6946c728d">gridfire::trigger::Trigger&lt; TriggerContextStruct &gt;</a>.</p>
</div>
</div>
<a id="a95a801aafb5aaa9a22566ebf722a1150" name="a95a801aafb5aaa9a22566ebf722a1150"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95a801aafb5aaa9a22566ebf722a1150">&#9670;&#160;</a></span>step()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html">gridfire::trigger::OrTrigger</a>&lt; TriggerContextStruct &gt;::step </td>
<td>(</td>
<td class="paramtype">const TriggerContextStruct &amp;&#160;</td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>similar to update but intended to be run on every step not just those where the trigger triggered </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>Context snapshot used to update state. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classgridfire_1_1trigger_1_1Trigger.html#a4b7ffa4d8d31e2118a8e86172be51041">gridfire::trigger::Trigger&lt; TriggerContextStruct &gt;</a>.</p>
</div>
</div>
<a id="a775dac97d109c5fcd5c0287ca98f308c" name="a775dac97d109c5fcd5c0287ca98f308c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a775dac97d109c5fcd5c0287ca98f308c">&#9670;&#160;</a></span>update()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html">gridfire::trigger::OrTrigger</a>&lt; TriggerContextStruct &gt;::update </td>
<td>(</td>
<td class="paramtype">const TriggerContextStruct &amp;&#160;</td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Update any internal state with the given context (e.g., counters, windows). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>Context snapshot used to update state. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classgridfire_1_1trigger_1_1Trigger.html#a048899795704f68668960454d118a6fc">gridfire::trigger::Trigger&lt; TriggerContextStruct &gt;</a>.</p>
</div>
</div>
<a id="a7bca0da16353f4b04a2f40fb29c07922" name="a7bca0da16353f4b04a2f40fb29c07922"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bca0da16353f4b04a2f40fb29c07922">&#9670;&#160;</a></span>why()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structgridfire_1_1trigger_1_1TriggerResult.html">TriggerResult</a> <a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html">gridfire::trigger::OrTrigger</a>&lt; TriggerContextStruct &gt;::why </td>
<td>(</td>
<td class="paramtype">const TriggerContextStruct &amp;&#160;</td>
<td class="paramname"><em>ctx</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Explain why the last evaluation would be true/false in a structured way. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>Context snapshot for the explanation. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="structgridfire_1_1trigger_1_1TriggerResult.html">TriggerResult</a> tree with a boolean value and per-cause details. </dd></dl>
<p>Implements <a class="el" href="classgridfire_1_1trigger_1_1Trigger.html#a9f020d828ca36a601b780566cc3377ea">gridfire::trigger::Trigger&lt; TriggerContextStruct &gt;</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a6da04b5b15371f7087be03bb337dbdd6" name="a6da04b5b15371f7087be03bb337dbdd6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6da04b5b15371f7087be03bb337dbdd6">&#9670;&#160;</a></span>m_A</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt;<a class="el" href="classgridfire_1_1trigger_1_1Trigger.html">Trigger</a>&lt;TriggerContextStruct&gt; &gt; <a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html">gridfire::trigger::OrTrigger</a>&lt; TriggerContextStruct &gt;::m_A</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a30dec370b61a5f0562956394b89e8f89" name="a30dec370b61a5f0562956394b89e8f89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30dec370b61a5f0562956394b89e8f89">&#9670;&#160;</a></span>m_B</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt;<a class="el" href="classgridfire_1_1trigger_1_1Trigger.html">Trigger</a>&lt;TriggerContextStruct&gt; &gt; <a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html">gridfire::trigger::OrTrigger</a>&lt; TriggerContextStruct &gt;::m_B</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a35d519d5266c68b696b779b275574ebf" name="a35d519d5266c68b696b779b275574ebf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35d519d5266c68b696b779b275574ebf">&#9670;&#160;</a></span>m_hits</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html">gridfire::trigger::OrTrigger</a>&lt; TriggerContextStruct &gt;::m_hits = 0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae72e6e9f1fbfbd11fbfe9aa6d4ff5a3b" name="ae72e6e9f1fbfbd11fbfe9aa6d4ff5a3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae72e6e9f1fbfbd11fbfe9aa6d4ff5a3b">&#9670;&#160;</a></span>m_misses</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html">gridfire::trigger::OrTrigger</a>&lt; TriggerContextStruct &gt;::m_misses = 0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="adc6f560d9199455ba98d85eadfe02847" name="adc6f560d9199455ba98d85eadfe02847"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc6f560d9199455ba98d85eadfe02847">&#9670;&#160;</a></span>m_resets</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html">gridfire::trigger::OrTrigger</a>&lt; TriggerContextStruct &gt;::m_resets = 0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a596db4a92ebf789cea1c431d3d2220c7" name="a596db4a92ebf789cea1c431d3d2220c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a596db4a92ebf789cea1c431d3d2220c7">&#9670;&#160;</a></span>m_steps</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html">gridfire::trigger::OrTrigger</a>&lt; TriggerContextStruct &gt;::m_steps = 0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af595a5daab0f5b3ffc450c6de6737517" name="af595a5daab0f5b3ffc450c6de6737517"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af595a5daab0f5b3ffc450c6de6737517">&#9670;&#160;</a></span>m_updates</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TriggerContextStruct &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html">gridfire::trigger::OrTrigger</a>&lt; TriggerContextStruct &gt;::m_updates = 0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/include/gridfire/trigger/<a class="el" href="trigger__logical_8h.html">trigger_logical.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<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="navelem"><a class="el" href="classgridfire_1_1trigger_1_1OrTrigger.html">OrTrigger</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.9.8 </li>
</ul>
</div>
</body>
</html>