Files
GridFire/docs/html/classgridfire_1_1io_1_1SimpleReactionListFileParser.html

341 lines
20 KiB
HTML

<!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::io::SimpleReactionListFileParser Class 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_1io_1_1SimpleReactionListFileParser.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-types">Private Types</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classgridfire_1_1io_1_1SimpleReactionListFileParser-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">gridfire::io::SimpleReactionListFileParser Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>A parser for simple text files containing a list of reactions.
<a href="classgridfire_1_1io_1_1SimpleReactionListFileParser.html#details">More...</a></p>
<p><code>#include &lt;network_file.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for gridfire::io::SimpleReactionListFileParser:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1io_1_1SimpleReactionListFileParser__inherit__graph.svg" width="210" height="139"><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::io::SimpleReactionListFileParser:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1io_1_1SimpleReactionListFileParser__coll__graph.svg" width="210" height="139"><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="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:afc8ed91e8c98205c505e3d9f0cff1993" id="r_afc8ed91e8c98205c505e3d9f0cff1993"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1io_1_1SimpleReactionListFileParser.html#afc8ed91e8c98205c505e3d9f0cff1993">SimpleReactionListFileParser</a> ()</td></tr>
<tr class="memdesc:afc8ed91e8c98205c505e3d9f0cff1993"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a <a class="el" href="classgridfire_1_1io_1_1SimpleReactionListFileParser.html" title="A parser for simple text files containing a list of reactions.">SimpleReactionListFileParser</a>. <br /></td></tr>
<tr class="separator:afc8ed91e8c98205c505e3d9f0cff1993"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4df01e3a93e1291d2cde0458545325f8" id="r_a4df01e3a93e1291d2cde0458545325f8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegridfire_1_1io.html#abcbdcbd13cfa8c9fbe1b48e8ee2cc352">ParsedNetworkData</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1io_1_1SimpleReactionListFileParser.html#a4df01e3a93e1291d2cde0458545325f8">parse</a> (const std::string &amp;filename) const override</td></tr>
<tr class="memdesc:a4df01e3a93e1291d2cde0458545325f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parses a simple reaction list file. <br /></td></tr>
<tr class="separator:a4df01e3a93e1291d2cde0458545325f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgridfire_1_1io_1_1NetworkFileParser"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgridfire_1_1io_1_1NetworkFileParser')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgridfire_1_1io_1_1NetworkFileParser.html">gridfire::io::NetworkFileParser</a></td></tr>
<tr class="memitem:a9b4095d06fad5df3805c92ae97b3eab3 inherit pub_methods_classgridfire_1_1io_1_1NetworkFileParser" id="r_a9b4095d06fad5df3805c92ae97b3eab3"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1io_1_1NetworkFileParser.html#a9b4095d06fad5df3805c92ae97b3eab3">~NetworkFileParser</a> ()=default</td></tr>
<tr class="memdesc:a9b4095d06fad5df3805c92ae97b3eab3 inherit pub_methods_classgridfire_1_1io_1_1NetworkFileParser"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor for the base class. <br /></td></tr>
<tr class="separator:a9b4095d06fad5df3805c92ae97b3eab3 inherit pub_methods_classgridfire_1_1io_1_1NetworkFileParser"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-types" name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:ad913155a5a2a36b29e4ce4ca8d71c036" id="r_ad913155a5a2a36b29e4ce4ca8d71c036"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1io_1_1SimpleReactionListFileParser.html#ad913155a5a2a36b29e4ce4ca8d71c036">Config</a> = fourdst::config::Config</td></tr>
<tr class="separator:ad913155a5a2a36b29e4ce4ca8d71c036"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f8f9a1f54cd2be5ec66c3181be892de" id="r_a6f8f9a1f54cd2be5ec66c3181be892de"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1io_1_1SimpleReactionListFileParser.html#a6f8f9a1f54cd2be5ec66c3181be892de">LogManager</a> = fourdst::logging::LogManager</td></tr>
<tr class="separator:a6f8f9a1f54cd2be5ec66c3181be892de"><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:a4061e99bd77a3de0d6d9e317bfc74874" id="r_a4061e99bd77a3de0d6d9e317bfc74874"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgridfire_1_1io_1_1SimpleReactionListFileParser.html#ad913155a5a2a36b29e4ce4ca8d71c036">Config</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1io_1_1SimpleReactionListFileParser.html#a4061e99bd77a3de0d6d9e317bfc74874">m_config</a> = Config::getInstance()</td></tr>
<tr class="separator:a4061e99bd77a3de0d6d9e317bfc74874"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acef7eafe3cbea159259f69c88d309b66" id="r_acef7eafe3cbea159259f69c88d309b66"><td class="memItemLeft" align="right" valign="top">quill::Logger *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1io_1_1SimpleReactionListFileParser.html#acef7eafe3cbea159259f69c88d309b66">m_logger</a> = LogManager::getInstance().getLogger(&quot;log&quot;)</td></tr>
<tr class="separator:acef7eafe3cbea159259f69c88d309b66"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A parser for simple text files containing a list of reactions. </p>
<p>This parser reads a file where each line contains a single reaction name. It supports comments (lines starting with '#') and ignores empty lines. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="ad913155a5a2a36b29e4ce4ca8d71c036" name="ad913155a5a2a36b29e4ce4ca8d71c036"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad913155a5a2a36b29e4ce4ca8d71c036">&#9670;&#160;</a></span>Config</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classgridfire_1_1io_1_1SimpleReactionListFileParser.html#ad913155a5a2a36b29e4ce4ca8d71c036">gridfire::io::SimpleReactionListFileParser::Config</a> = fourdst::config::Config</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="a6f8f9a1f54cd2be5ec66c3181be892de" name="a6f8f9a1f54cd2be5ec66c3181be892de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f8f9a1f54cd2be5ec66c3181be892de">&#9670;&#160;</a></span>LogManager</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classgridfire_1_1io_1_1SimpleReactionListFileParser.html#a6f8f9a1f54cd2be5ec66c3181be892de">gridfire::io::SimpleReactionListFileParser::LogManager</a> = fourdst::logging::LogManager</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>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="afc8ed91e8c98205c505e3d9f0cff1993" name="afc8ed91e8c98205c505e3d9f0cff1993"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc8ed91e8c98205c505e3d9f0cff1993">&#9670;&#160;</a></span>SimpleReactionListFileParser()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">gridfire::io::SimpleReactionListFileParser::SimpleReactionListFileParser </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a <a class="el" href="classgridfire_1_1io_1_1SimpleReactionListFileParser.html" title="A parser for simple text files containing a list of reactions.">SimpleReactionListFileParser</a>. </p>
<dl class="section post"><dt>Postcondition</dt><dd>The parser is initialized and ready to parse files. </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a4df01e3a93e1291d2cde0458545325f8" name="a4df01e3a93e1291d2cde0458545325f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4df01e3a93e1291d2cde0458545325f8">&#9670;&#160;</a></span>parse()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacegridfire_1_1io.html#abcbdcbd13cfa8c9fbe1b48e8ee2cc352">ParsedNetworkData</a> gridfire::io::SimpleReactionListFileParser::parse </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>filename</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>Parses a simple reaction list file. </p>
<p>This method reads the specified file line by line. It trims whitespace from each line, ignores lines that are empty or start with a '#' comment character, and stores the remaining lines as reaction names.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>The path to the simple reaction list file. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <code>ParsedNetworkData</code> struct containing the list of reaction names.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::runtime_error</td><td>If the file cannot be opened for reading.</td></tr>
</table>
</dd>
</dl>
<p><b>Algorithm</b> </p><ol type="1">
<li>Opens the specified file.</li>
<li>Reads the file line by line.</li>
<li>For each line, it removes any trailing comments (starting with '#').</li>
<li>Trims leading and trailing whitespace.</li>
<li>If the line is not empty, it is added to the list of reaction names.</li>
<li>Returns the populated <code>ParsedNetworkData</code> struct.</li>
</ol>
<p><b>Usage</b> </p><div class="fragment"><div class="line"><a class="code hl_class" href="classgridfire_1_1io_1_1SimpleReactionListFileParser.html">SimpleReactionListFileParser</a> parser;</div>
<div class="line"><a class="code hl_typedef" href="namespacegridfire_1_1io.html#abcbdcbd13cfa8c9fbe1b48e8ee2cc352">ParsedNetworkData</a> data = parser.<a class="code hl_function" href="classgridfire_1_1io_1_1SimpleReactionListFileParser.html#a4df01e3a93e1291d2cde0458545325f8">parse</a>(<span class="stringliteral">&quot;reactions.txt&quot;</span>);</div>
<div class="ttc" id="aclassgridfire_1_1io_1_1SimpleReactionListFileParser_html"><div class="ttname"><a href="classgridfire_1_1io_1_1SimpleReactionListFileParser.html">gridfire::io::SimpleReactionListFileParser</a></div><div class="ttdoc">A parser for simple text files containing a list of reactions.</div><div class="ttdef"><b>Definition</b> network_file.h:68</div></div>
<div class="ttc" id="aclassgridfire_1_1io_1_1SimpleReactionListFileParser_html_a4df01e3a93e1291d2cde0458545325f8"><div class="ttname"><a href="classgridfire_1_1io_1_1SimpleReactionListFileParser.html#a4df01e3a93e1291d2cde0458545325f8">gridfire::io::SimpleReactionListFileParser::parse</a></div><div class="ttdeci">ParsedNetworkData parse(const std::string &amp;filename) const override</div><div class="ttdoc">Parses a simple reaction list file.</div><div class="ttdef"><b>Definition</b> network_file.cpp:44</div></div>
<div class="ttc" id="anamespacegridfire_1_1io_html_abcbdcbd13cfa8c9fbe1b48e8ee2cc352"><div class="ttname"><a href="namespacegridfire_1_1io.html#abcbdcbd13cfa8c9fbe1b48e8ee2cc352">gridfire::io::ParsedNetworkData</a></div><div class="ttdeci">std::vector&lt; std::string &gt; ParsedNetworkData</div><div class="ttdef"><b>Definition</b> network_file.h:12</div></div>
</div><!-- fragment -->
<p>Implements <a class="el" href="classgridfire_1_1io_1_1NetworkFileParser.html#a66e8e724c903d6ef4dd1c8103276bdbf">gridfire::io::NetworkFileParser</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a4061e99bd77a3de0d6d9e317bfc74874" name="a4061e99bd77a3de0d6d9e317bfc74874"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4061e99bd77a3de0d6d9e317bfc74874">&#9670;&#160;</a></span>m_config</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgridfire_1_1io_1_1SimpleReactionListFileParser.html#ad913155a5a2a36b29e4ce4ca8d71c036">Config</a>&amp; gridfire::io::SimpleReactionListFileParser::m_config = Config::getInstance()</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="acef7eafe3cbea159259f69c88d309b66" name="acef7eafe3cbea159259f69c88d309b66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acef7eafe3cbea159259f69c88d309b66">&#9670;&#160;</a></span>m_logger</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">quill::Logger* gridfire::io::SimpleReactionListFileParser::m_logger = LogManager::getInstance().getLogger(&quot;log&quot;)</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>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/include/gridfire/io/<a class="el" href="network__file_8h.html">network_file.h</a></li>
<li>src/lib/io/<a class="el" href="network__file_8cpp.html">network_file.cpp</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_1io.html">io</a></li><li class="navelem"><a class="el" href="classgridfire_1_1io_1_1SimpleReactionListFileParser.html">SimpleReactionListFileParser</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>