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 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 = "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('namespacegridfire_1_1trigger.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 = "#namespaces" > Namespaces< / a > |
< a href = "#nested-classes" > Classes< / a > |
< a href = "#func-members" > Functions< / a > < / div >
< div class = "headertitle" > < div class = "title" > gridfire::trigger Namespace Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< 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   < / 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" >   < / 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   < / 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" >   < / 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 = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > class   < / 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" >   < / 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 = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > class   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1trigger_1_1_logical_trigger.html" > LogicalTrigger< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > class   < / 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" >   < / 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 = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > class   < / 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" >   < / 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 = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > class   < / 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" >   < / 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 = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structgridfire_1_1trigger_1_1_trigger_result.html" > TriggerResult< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / 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  < / 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 > & result, const int indent=0)< / td > < / tr >
< tr class = "memdesc:a5e0fe21f3356426f26b109cdeb1edcd9" > < td class = "mdescLeft" >   < / 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 = "separator:a5e0fe21f3356426f26b109cdeb1edcd9" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< h2 class = "groupheader" > Function Documentation< / h2 >
< a id = "a5e0fe21f3356426f26b109cdeb1edcd9" name = "a5e0fe21f3356426f26b109cdeb1edcd9" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a5e0fe21f3356426f26b109cdeb1edcd9" > ◆   < / a > < / span > printWhy()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< 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 > & < / td > < td class = "paramname" > < span class = "paramname" > < em > result< / em > < / span > , < / 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 >   )< / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel inline" > 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 > 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" > 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" > " A> 5" < / span > , < span class = "stringliteral" > " Threshold passed" < / span > , < span class = "keyword" > true< / span > , {}};< / div >
< div class = "line" > TriggerResult root{< span class = "stringliteral" > " AND" < / span > , < span class = "stringliteral" > " Both conditions true" < / 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 & 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 > <!-- fragment --> < / dd > < / dl >
< / div >
< / div >
< / 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 = "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 >