2025-10-08 11:17:09 -04:00
<!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.13.2" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > GridFire: gridfire::trigger::LogicalTrigger< TriggerContextStruct > 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 >
< script type = "text/javascript" src = "clipboard.js" > < / script >
< link href = "navtree.css" rel = "stylesheet" type = "text/css" / >
< 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 >
< 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" >
2025-11-04 14:04:26 -05:00
< div id = "projectname" > GridFire< span id = "projectnumber" >   v0.7.0-alpha< / span >
2025-10-08 11:17:09 -04:00
< / div >
< div id = "projectbrief" > General Purpose Nuclear Network< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
< / script >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& 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& dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(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& dn=expat.txt MIT */
$(function(){initNavTree('classgridfire_1_1trigger_1_1_logical_trigger.html',''); initResizable(true); });
/* @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 = "classgridfire_1_1trigger_1_1_logical_trigger-members.html" > List of all members< / a > < / div >
< div class = "headertitle" > < div class = "title" > gridfire::trigger::LogicalTrigger< TriggerContextStruct > Class Template Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< p > < code > #include < trigger_logical.h> < / code > < / p >
< div class = "dynheader" >
Inheritance diagram for gridfire::trigger::LogicalTrigger< TriggerContextStruct > :< / div >
< div class = "dyncontent" >
< div class = "center" >
< img src = "classgridfire_1_1trigger_1_1_logical_trigger.png" usemap = "#gridfire::trigger::LogicalTrigger_3C_20TriggerContextStruct_20_3E_map" alt = "" / >
< map id = "gridfire::trigger::LogicalTrigger_3C_20TriggerContextStruct_20_3E_map" name = "gridfire::trigger::LogicalTrigger_3C_20TriggerContextStruct_20_3E_map" >
< area href = "classgridfire_1_1trigger_1_1_trigger.html" title = "Generic trigger interface for signaling events/conditions during integration." alt = "gridfire::trigger::Trigger< TriggerContextStruct >" shape = "rect" coords = "519,0,855,24" / >
< area href = "classgridfire_1_1trigger_1_1_and_trigger.html" title = "Logical conjunction of two triggers with short-circuit evaluation." alt = "gridfire::trigger::AndTrigger< TriggerContextStruct >" shape = "rect" coords = "0,112,336,136" / >
< area href = "classgridfire_1_1trigger_1_1_every_nth_trigger.html" title = "Pass-through trigger that fires every Nth time its child trigger is true." alt = "gridfire::trigger::EveryNthTrigger< TriggerContextStruct >" shape = "rect" coords = "346,112,682,136" / >
< area href = "classgridfire_1_1trigger_1_1_not_trigger.html" title = "Logical negation of a trigger." alt = "gridfire::trigger::NotTrigger< TriggerContextStruct >" shape = "rect" coords = "692,112,1028,136" / >
< area href = "classgridfire_1_1trigger_1_1_or_trigger.html" title = "Logical disjunction of two triggers with short-circuit evaluation." alt = "gridfire::trigger::OrTrigger< TriggerContextStruct >" shape = "rect" coords = "1038,112,1374,136" / >
< / map >
< / div > < / div >
< 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_1trigger_1_1_trigger" > < td colspan = "2" onclick = "javascript:dynsection.toggleInherit('pub_methods_classgridfire_1_1trigger_1_1_trigger')" > < img src = "closed.png" alt = "-" / >   Public Member Functions inherited from < a class = "el" href = "classgridfire_1_1trigger_1_1_trigger.html" > gridfire::trigger::Trigger< TriggerContextStruct > < / a > < / td > < / tr >
< tr class = "memitem:a2c077ccbaf4de9f7068e50144391edda inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" id = "r_a2c077ccbaf4de9f7068e50144391edda" > < td class = "memItemLeft" align = "right" valign = "top" > virtual  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1trigger_1_1_trigger.html#a2c077ccbaf4de9f7068e50144391edda" > ~Trigger< / a > ()=default< / td > < / tr >
< tr class = "memdesc:a2c077ccbaf4de9f7068e50144391edda inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Virtual destructor for polymorphic use. < br / > < / td > < / tr >
< tr class = "separator:a2c077ccbaf4de9f7068e50144391edda inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a1579ffb1c841cda4e67990b42d400d88 inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" id = "r_a1579ffb1c841cda4e67990b42d400d88" > < td class = "memItemLeft" align = "right" valign = "top" > virtual bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1trigger_1_1_trigger.html#a1579ffb1c841cda4e67990b42d400d88" > check< / a > (const TriggerContextStruct & ctx) const =0< / td > < / tr >
< tr class = "memdesc:a1579ffb1c841cda4e67990b42d400d88 inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Evaluate the trigger condition against the provided context. < br / > < / td > < / tr >
< tr class = "separator:a1579ffb1c841cda4e67990b42d400d88 inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a048899795704f68668960454d118a6fc inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" id = "r_a048899795704f68668960454d118a6fc" > < td class = "memItemLeft" align = "right" valign = "top" > virtual void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1trigger_1_1_trigger.html#a048899795704f68668960454d118a6fc" > update< / a > (const TriggerContextStruct & ctx)=0< / td > < / tr >
< tr class = "memdesc:a048899795704f68668960454d118a6fc inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Update any internal state with the given context (e.g., counters, windows). < br / > < / td > < / tr >
< tr class = "separator:a048899795704f68668960454d118a6fc inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-11-04 14:04:26 -05:00
< tr class = "memitem:a4b7ffa4d8d31e2118a8e86172be51041 inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" id = "r_a4b7ffa4d8d31e2118a8e86172be51041" > < td class = "memItemLeft" align = "right" valign = "top" > virtual void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1trigger_1_1_trigger.html#a4b7ffa4d8d31e2118a8e86172be51041" > step< / a > (const TriggerContextStruct & ctx)=0< / td > < / tr >
< tr class = "memdesc:a4b7ffa4d8d31e2118a8e86172be51041 inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" > < td class = "mdescLeft" >   < / 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:a4b7ffa4d8d31e2118a8e86172be51041 inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2025-10-08 11:17:09 -04:00
< tr class = "memitem:af652af761675736419b961b6946c728d inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" id = "r_af652af761675736419b961b6946c728d" > < td class = "memItemLeft" align = "right" valign = "top" > virtual void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1trigger_1_1_trigger.html#af652af761675736419b961b6946c728d" > reset< / a > ()=0< / td > < / tr >
< tr class = "memdesc:af652af761675736419b961b6946c728d inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Reset internal state and diagnostics counters. < br / > < / td > < / tr >
< tr class = "separator:af652af761675736419b961b6946c728d inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a3e5b017147f22ca0733733cd39e334b7 inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" id = "r_a3e5b017147f22ca0733733cd39e334b7" > < td class = "memItemLeft" align = "right" valign = "top" > virtual std::string  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1trigger_1_1_trigger.html#a3e5b017147f22ca0733733cd39e334b7" > name< / a > () const =0< / td > < / tr >
< tr class = "memdesc:a3e5b017147f22ca0733733cd39e334b7 inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Short, stable name for this trigger (suitable for logs/UI). < br / > < / td > < / tr >
< tr class = "separator:a3e5b017147f22ca0733733cd39e334b7 inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a402cdd062e9479abbcca02e3d94e528f inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" id = "r_a402cdd062e9479abbcca02e3d94e528f" > < td class = "memItemLeft" align = "right" valign = "top" > virtual std::string  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1trigger_1_1_trigger.html#a402cdd062e9479abbcca02e3d94e528f" > describe< / a > () const =0< / td > < / tr >
< tr class = "memdesc:a402cdd062e9479abbcca02e3d94e528f inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Human-readable description of this trigger's logic. < br / > < / td > < / tr >
< tr class = "separator:a402cdd062e9479abbcca02e3d94e528f inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a9f020d828ca36a601b780566cc3377ea inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" id = "r_a9f020d828ca36a601b780566cc3377ea" > < td class = "memItemLeft" align = "right" valign = "top" > virtual < a class = "el" href = "structgridfire_1_1trigger_1_1_trigger_result.html" > TriggerResult< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1trigger_1_1_trigger.html#a9f020d828ca36a601b780566cc3377ea" > why< / a > (const TriggerContextStruct & ctx) const =0< / td > < / tr >
< tr class = "memdesc:a9f020d828ca36a601b780566cc3377ea inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Explain why the last evaluation would be true/false in a structured way. < br / > < / td > < / tr >
< tr class = "separator:a9f020d828ca36a601b780566cc3377ea inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a4ea3abfb76a09c4f55ad05d73a2cf12d inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" id = "r_a4ea3abfb76a09c4f55ad05d73a2cf12d" > < td class = "memItemLeft" align = "right" valign = "top" > virtual size_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1trigger_1_1_trigger.html#a4ea3abfb76a09c4f55ad05d73a2cf12d" > numTriggers< / a > () const =0< / td > < / tr >
< tr class = "memdesc:a4ea3abfb76a09c4f55ad05d73a2cf12d inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Total number of times this trigger evaluated to true since last reset. < br / > < / td > < / tr >
< tr class = "separator:a4ea3abfb76a09c4f55ad05d73a2cf12d inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a81848e5af844795d879b6d885a2701d7 inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" id = "r_a81848e5af844795d879b6d885a2701d7" > < td class = "memItemLeft" align = "right" valign = "top" > virtual size_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1trigger_1_1_trigger.html#a81848e5af844795d879b6d885a2701d7" > numMisses< / a > () const =0< / td > < / tr >
< tr class = "memdesc:a81848e5af844795d879b6d885a2701d7 inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Total number of times this trigger evaluated to false since last reset. < br / > < / td > < / tr >
< tr class = "separator:a81848e5af844795d879b6d885a2701d7 inherit pub_methods_classgridfire_1_1trigger_1_1_trigger" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< 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_1_logical_trigger.html" > LogicalTrigger< / 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 >
< / ul >
< / div >
< / body >
< / html >
