Files
musrfit/doc/technical/html/PStartupHandler_8h.html
Gitea Actions 8a8eac55b7 Deploy site
2025-12-27 12:57:44 +00:00

205 lines
12 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.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>musrfit: /workspace/LMU/musrfit/src/include/PStartupHandler.h File 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="doxygen.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">musrfit<span id="projectnumber">&#160;1.9.9</span>
</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&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('',false,false,'search.php','Search',true);
});
/* @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 */
$(function(){initNavTree('PStartupHandler_8h.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">PStartupHandler.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;TObject.h&gt;</code><br />
<code>#include &lt;TQObject.h&gt;</code><br />
<code>#include &lt;TList.h&gt;</code><br />
<code>#include &lt;TString.h&gt;</code><br />
<code>#include &lt;TSAXParser.h&gt;</code><br />
<code>#include &quot;<a class="el" href="PMusr_8h_source.html">PMusr.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for PStartupHandler.h:</div>
<div class="dyncontent">
<div class="center"><img src="PStartupHandler_8h__incl.png" border="0" usemap="#a_2workspace_2LMU_2musrfit_2src_2include_2PStartupHandler_8h" alt=""/></div>
<map name="a_2workspace_2LMU_2musrfit_2src_2include_2PStartupHandler_8h" id="a_2workspace_2LMU_2musrfit_2src_2include_2PStartupHandler_8h">
<area shape="rect" title=" " alt="" coords="182,5,390,50"/>
<area shape="rect" title=" " alt="" coords="5,98,85,126"/>
<area shape="poly" title=" " alt="" coords="223,53,99,95,97,90,221,48"/>
<area shape="rect" title=" " alt="" coords="108,98,198,126"/>
<area shape="poly" title=" " alt="" coords="252,53,188,92,186,87,250,48"/>
<area shape="rect" title=" " alt="" coords="222,98,284,126"/>
<area shape="poly" title=" " alt="" coords="280,51,267,85,262,82,275,49"/>
<area shape="rect" title=" " alt="" coords="298,174,374,201"/>
<area shape="poly" title=" " alt="" coords="296,49,330,158,325,160,290,51"/>
<area shape="rect" title=" " alt="" coords="358,98,460,126"/>
<area shape="poly" title=" " alt="" coords="320,48,378,87,375,91,317,53"/>
<area shape="rect" href="PMusr_8h.html" title=" " alt="" coords="484,98,553,126"/>
<area shape="poly" title=" " alt="" coords="349,48,470,91,468,96,347,53"/>
<area shape="poly" title=" " alt="" coords="487,129,383,170,381,165,485,124"/>
<area shape="rect" title=" " alt="" coords="412,174,470,201"/>
<area shape="poly" title=" " alt="" coords="506,128,467,165,464,161,503,124"/>
<area shape="rect" title=" " alt="" coords="494,174,542,201"/>
<area shape="poly" title=" " alt="" coords="521,126,521,158,516,158,516,126"/>
<area shape="rect" title=" " alt="" coords="566,174,630,201"/>
<area shape="poly" title=" " alt="" coords="534,124,575,161,571,165,531,128"/>
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="PStartupHandler_8h__dep__incl.png" border="0" usemap="#a_2workspace_2LMU_2musrfit_2src_2include_2PStartupHandler_8hdep" alt=""/></div>
<map name="a_2workspace_2LMU_2musrfit_2src_2include_2PStartupHandler_8hdep" id="a_2workspace_2LMU_2musrfit_2src_2include_2PStartupHandler_8hdep">
<area shape="rect" title=" " alt="" coords="817,5,1025,50"/>
<area shape="rect" href="addRun_8cpp.html" title=" " alt="" coords="5,98,176,143"/>
<area shape="poly" title=" " alt="" coords="802,39,521,61,354,78,188,101,176,103,175,97,187,95,354,73,521,55,802,33"/>
<area shape="rect" href="any2many_8cpp.html" title=" " alt="" coords="200,98,370,143"/>
<area shape="poly" title=" " alt="" coords="802,44,605,68,383,101,371,103,370,98,382,95,604,62,801,39"/>
<area shape="rect" href="PStartupHandler_8cpp.html" title=" " alt="" coords="394,98,616,143"/>
<area shape="poly" title=" " alt="" coords="807,56,606,100,605,95,806,51"/>
<area shape="rect" href="dump__header_8cpp.html" title=" " alt="" coords="640,98,810,143"/>
<area shape="poly" title=" " alt="" coords="861,59,773,100,771,95,859,55"/>
<area shape="rect" href="PMsr2Data_8h.html" title=" " alt="" coords="835,98,1007,143"/>
<area shape="poly" title=" " alt="" coords="924,66,924,98,918,98,918,66"/>
<area shape="rect" href="musrFT_8cpp.html" title=" " alt="" coords="1032,98,1202,143"/>
<area shape="poly" title=" " alt="" coords="983,55,1071,95,1069,100,981,59"/>
<area shape="rect" href="musrfit_8cpp.html" title=" " alt="" coords="1227,98,1397,143"/>
<area shape="poly" title=" " alt="" coords="1030,51,1227,97,1226,102,1029,57"/>
<area shape="rect" href="musrt0_8cpp.html" title=" " alt="" coords="1421,98,1592,143"/>
<area shape="poly" title=" " alt="" coords="1041,41,1215,64,1410,95,1422,98,1421,103,1409,101,1215,70,1040,46"/>
<area shape="rect" href="musrview_8cpp.html" title=" " alt="" coords="1616,98,1786,143"/>
<area shape="poly" title=" " alt="" coords="1041,34,1300,57,1453,74,1604,95,1616,97,1615,103,1603,101,1452,79,1300,62,1040,40"/>
<area shape="rect" href="PMsr2Data_8cpp.html" title=" " alt="" coords="727,191,912,235"/>
<area shape="poly" title=" " alt="" coords="888,155,846,192,842,188,884,151"/>
<area shape="rect" href="msr2data_8cpp.html" title=" " alt="" coords="936,191,1106,235"/>
<area shape="poly" title=" " alt="" coords="958,151,999,188,996,192,954,155"/>
</map>
</div>
</div>
<p><a href="PStartupHandler_8h_source.html">Go to the source code of this file.</a></p>
<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="classPStartupHandler.html">PStartupHandler</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handles the musrfit XML startup configuration file (musrfit_startup.xml). <a href="classPStartupHandler.html#details">More...</a><br /></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:a2f473e587e18e6a64b260870ec870a5e" id="r_a2f473e587e18e6a64b260870ec870a5e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2f473e587e18e6a64b260870ec870a5e">parseXmlFile</a> (TSAXParser *, const char *)</td></tr>
<tr class="memdesc:a2f473e587e18e6a64b260870ec870a5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Replacement function for TSAXParser::ParseFile(). <br /></td></tr>
<tr class="separator:a2f473e587e18e6a64b260870ec870a5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a2f473e587e18e6a64b260870ec870a5e" name="a2f473e587e18e6a64b260870ec870a5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f473e587e18e6a64b260870ec870a5e">&#9670;&#160;</a></span>parseXmlFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int parseXmlFile </td>
<td>(</td>
<td class="paramtype">TSAXParser *</td> <td class="paramname"><span class="paramname"><em></em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em></em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Replacement function for TSAXParser::ParseFile(). </p>
<p>This standalone function provides a workaround for environments where TSAXParser::ParseFile() does not work correctly but ParseBuffer() does. It reads the entire XML file into memory and then parses it as a buffer.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">saxParser</td><td>Pointer to an initialized TSAXParser object with connected slots </td></tr>
<tr><td class="paramname">startup_path_name</td><td>Full path to the XML file to be parsed</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Parse status:<ul>
<li>0: Success</li>
<li>1: File could not be read</li>
<li>Other: XML parse error code from TSAXParser::ParseBuffer()</li>
</ul>
</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPStartupHandler.html" title="Handles the musrfit XML startup configuration file (musrfit_startup.xml).">PStartupHandler</a> </dd></dl>
<p class="reference">Referenced by <a class="el" href="addRun_8cpp_source.html#l00364">main()</a>, <a class="el" href="musrFT_8cpp_source.html#l00996">main()</a>, and <a class="el" href="PMsr2Data_8cpp_source.html#l00482">PMsr2Data::ParseXmlStartupFile()</a>.</p>
</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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b0856f6b0d80ccb263b2f415c91f9e17.html">include</a></li><li class="navelem"><a class="el" href="PStartupHandler_8h.html">PStartupHandler.h</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>