Files
musrfit/doc/technical/html/PUserFcnBase_8h.html
T
Gitea Actions b6fac619f9 Deploy site
2026-05-28 07:32:41 +00:00

228 lines
14 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/PUserFcnBase.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.10.0</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('PUserFcnBase_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">PUserFcnBase.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;vector&gt;</code><br />
<code>#include &quot;TObject.h&quot;</code><br />
<code>#include &quot;TSAXParser.h&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for PUserFcnBase.h:</div>
<div class="dyncontent">
<div class="center"><img src="PUserFcnBase_8h__incl.png" border="0" usemap="#a_2workspace_2LMU_2musrfit_2src_2include_2PUserFcnBase_8h" alt=""/></div>
<map name="a_2workspace_2LMU_2musrfit_2src_2include_2PUserFcnBase_8h" id="a_2workspace_2LMU_2musrfit_2src_2include_2PUserFcnBase_8h">
<area shape="rect" title=" " alt="" coords="32,5,224,50"/>
<area shape="rect" title=" " alt="" coords="5,98,64,126"/>
<area shape="poly" title=" " alt="" coords="105,52,63,90,59,85,102,48"/>
<area shape="rect" title=" " alt="" coords="88,98,168,126"/>
<area shape="poly" title=" " alt="" coords="130,50,130,82,125,82,125,50"/>
<area shape="rect" title=" " alt="" coords="192,98,293,126"/>
<area shape="poly" title=" " alt="" coords="160,48,213,86,210,91,156,53"/>
</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="PUserFcnBase_8h__dep__incl.png" border="0" usemap="#a_2workspace_2LMU_2musrfit_2src_2include_2PUserFcnBase_8hdep" alt=""/></div>
<map name="a_2workspace_2LMU_2musrfit_2src_2include_2PUserFcnBase_8hdep" id="a_2workspace_2LMU_2musrfit_2src_2include_2PUserFcnBase_8hdep">
<area shape="rect" title=" " alt="" coords="1035,5,1227,50"/>
<area shape="rect" href="PUserFcnBase_8cpp.html" title=" " alt="" coords="816,98,1022,143"/>
<area shape="poly" title=" " alt="" coords="1067,59,971,100,969,95,1065,54"/>
<area shape="rect" href="PTheory_8h.html" title=" " alt="" coords="1046,98,1216,143"/>
<area shape="poly" title=" " alt="" coords="1134,66,1134,98,1128,98,1128,66"/>
<area shape="rect" href="PUserFcn_8h.html" title=" " alt="" coords="1242,98,1412,143"/>
<area shape="poly" title=" " alt="" coords="1193,55,1281,95,1279,100,1191,59"/>
<area shape="rect" href="PTheory_8cpp.html" title=" " alt="" coords="1046,191,1216,235"/>
<area shape="poly" title=" " alt="" coords="1134,158,1134,190,1128,190,1128,158"/>
<area shape="rect" href="PRunBase_8h.html" title=" " alt="" coords="851,191,1022,235"/>
<area shape="poly" title=" " alt="" coords="1072,152,984,193,982,188,1069,147"/>
<area shape="rect" href="PRunBase_8cpp.html" title=" " alt="" coords="5,283,185,328"/>
<area shape="poly" title=" " alt="" coords="836,223,548,245,372,263,197,286,185,288,185,283,196,281,372,258,548,240,836,217"/>
<area shape="rect" href="PRunAsymmetry_8h.html" title=" " alt="" coords="208,283,414,328"/>
<area shape="poly" title=" " alt="" coords="836,229,646,254,426,286,415,288,414,283,425,281,645,249,836,224"/>
<area shape="rect" href="PRunAsymmetryBNMR_8h.html" title=" " alt="" coords="438,283,680,328"/>
<area shape="poly" title=" " alt="" coords="837,241,650,285,649,280,835,236"/>
<area shape="rect" href="PRunAsymmetryRRF_8h.html" title=" " alt="" coords="704,283,934,328"/>
<area shape="poly" title=" " alt="" coords="898,247,849,285,845,281,895,243"/>
<area shape="rect" href="PRunMuMinus_8h.html" title=" " alt="" coords="958,283,1149,328"/>
<area shape="poly" title=" " alt="" coords="978,243,1027,281,1024,285,974,247"/>
<area shape="rect" href="PRunNonMusr_8h.html" title=" " alt="" coords="1173,283,1366,328"/>
<area shape="poly" title=" " alt="" coords="1031,237,1191,280,1189,285,1030,242"/>
<area shape="rect" href="PRunSingleHisto_8h.html" title=" " alt="" coords="1390,283,1597,328"/>
<area shape="poly" title=" " alt="" coords="1037,233,1210,258,1379,281,1390,283,1390,288,1379,286,1209,263,1036,238"/>
<area shape="rect" href="PRunSingleHistoRRF_8h.html" title=" " alt="" coords="1622,283,1853,328"/>
<area shape="poly" title=" " alt="" coords="1037,233,1198,252,1325,259,1450,265,1610,281,1622,282,1621,288,1609,286,1450,271,1324,264,1198,257,1036,238"/>
<area shape="rect" href="PRunAsymmetry_8cpp.html" title=" " alt="" coords="36,384,255,429"/>
<area shape="poly" title=" " alt="" coords="263,339,183,386,181,382,260,334"/>
<area shape="rect" href="PRunListCollection_8h.html" title=" " alt="" coords="826,384,1047,429"/>
<area shape="poly" title=" " alt="" coords="429,326,538,340,623,348,708,357,814,373,853,381,852,387,813,379,707,362,623,353,537,345,428,331"/>
<area shape="rect" href="PRunListCollection_8cpp.html" title=" " alt="" coords="479,486,714,530"/>
<area shape="poly" title=" " alt="" coords="848,437,672,488,670,483,846,431"/>
<area shape="rect" href="PFitter_8h.html" title=" " alt="" coords="583,578,754,623"/>
<area shape="poly" title=" " alt="" coords="867,438,822,460,778,488,726,534,687,580,683,576,722,531,775,484,819,456,864,433"/>
<area shape="rect" href="musrfit_8cpp.html" title=" " alt="" coords="846,671,1016,716"/>
<area shape="poly" title=" " alt="" coords="958,442,974,485,986,554,985,585,976,624,965,650,951,672,946,669,960,647,971,622,980,585,981,555,968,486,953,444"/>
<area shape="rect" href="PFitterFcn_8h.html" title=" " alt="" coords="788,486,959,530"/>
<area shape="poly" title=" " alt="" coords="917,444,889,487,885,484,912,441"/>
<area shape="rect" href="PMusrCanvas_8h.html" title=" " alt="" coords="1043,486,1230,530"/>
<area shape="poly" title=" " alt="" coords="995,434,1094,483,1091,487,993,439"/>
<area shape="rect" href="musrview_8cpp.html" title=" " alt="" coords="1260,578,1431,623"/>
<area shape="poly" title=" " alt="" coords="1040,431,1243,483,1272,504,1297,529,1334,576,1330,579,1293,533,1268,508,1241,488,1038,436"/>
<area shape="rect" href="PFitter_8cpp.html" title=" " alt="" coords="583,671,754,716"/>
<area shape="poly" title=" " alt="" coords="671,639,671,671,666,671,666,639"/>
<area shape="poly" title=" " alt="" coords="746,626,869,668,867,673,744,631"/>
<area shape="poly" title=" " alt="" coords="812,539,719,580,716,575,810,534"/>
<area shape="rect" href="PFitterFcn_8cpp.html" title=" " alt="" coords="778,578,961,623"/>
<area shape="poly" title=" " alt="" coords="875,546,873,578,868,578,869,546"/>
<area shape="rect" href="PMusrCanvas_8cpp.html" title=" " alt="" coords="1036,578,1236,623"/>
<area shape="poly" title=" " alt="" coords="1139,546,1139,578,1134,578,1134,546"/>
<area shape="poly" title=" " alt="" coords="1202,534,1297,575,1295,580,1199,539"/>
<area shape="poly" title=" " alt="" coords="657,330,854,381,853,387,656,335"/>
<area shape="rect" href="PRunAsymmetryBNMR_8cpp.html" title=" " alt="" coords="279,384,535,429"/>
<area shape="poly" title=" " alt="" coords="515,339,442,386,439,382,512,334"/>
<area shape="poly" title=" " alt="" coords="858,336,913,382,909,386,855,340"/>
<area shape="rect" href="PRunAsymmetryRRF_8cpp.html" title=" " alt="" coords="559,384,802,429"/>
<area shape="poly" title=" " alt="" coords="778,339,712,386,709,382,775,335"/>
<area shape="poly" title=" " alt="" coords="1018,340,963,386,960,382,1015,336"/>
<area shape="rect" href="PRunMuMinus_8cpp.html" title=" " alt="" coords="1072,384,1276,429"/>
<area shape="poly" title=" " alt="" coords="1093,336,1149,382,1146,386,1090,340"/>
<area shape="poly" title=" " alt="" coords="1183,335,1010,386,1009,381,1181,330"/>
<area shape="rect" href="PRunNonMusr_8cpp.html" title=" " alt="" coords="1300,384,1506,429"/>
<area shape="poly" title=" " alt="" coords="1312,335,1376,382,1373,386,1309,340"/>
<area shape="poly" title=" " alt="" coords="1375,331,1216,354,1059,379,1022,387,1021,381,1059,373,1215,348,1375,326"/>
<area shape="rect" href="PRunSingleHisto_8cpp.html" title=" " alt="" coords="1530,384,1750,429"/>
<area shape="poly" title=" " alt="" coords="1540,335,1610,382,1607,386,1537,339"/>
<area shape="poly" title=" " alt="" coords="1607,331,1452,345,1331,351,1211,359,1059,379,1019,387,1018,381,1059,373,1210,354,1330,346,1452,340,1606,326"/>
<area shape="rect" href="PRunSingleHistoRRF_8cpp.html" title=" " alt="" coords="1775,376,1970,438"/>
<area shape="poly" title=" " alt="" coords="1781,335,1833,373,1830,378,1777,339"/>
<area shape="rect" href="PUserFcn_8cpp.html" title=" " alt="" coords="1240,191,1417,235"/>
<area shape="poly" title=" " alt="" coords="1330,158,1331,190,1325,191,1325,158"/>
</map>
</div>
</div>
<p><a href="PUserFcnBase_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="classPUserFcnBase.html">PUserFcnBase</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abstract base class for user-defined theory functions in musrfit. <a href="classPUserFcnBase.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:ad28f17f204891201dafd4815d71e362a" id="r_ad28f17f204891201dafd4815d71e362a"><td class="memItemLeft" align="right" valign="top">Int_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad28f17f204891201dafd4815d71e362a">parseXmlFile</a> (TSAXParser *, const Char_t *)</td></tr>
<tr class="separator:ad28f17f204891201dafd4815d71e362a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ad28f17f204891201dafd4815d71e362a" name="ad28f17f204891201dafd4815d71e362a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad28f17f204891201dafd4815d71e362a">&#9670;&#160;</a></span>parseXmlFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Int_t 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_t *</td> <td class="paramname"><span class="paramname"><em></em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>XML file parser for user function configurations.</p>
<p>This function provides a replacement for TSAXParser::ParseFile with better error handling for XML configuration files used by some user functions to load parameters or settings.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parser</td><td>Pointer to TSAXParser object </td></tr>
<tr><td class="paramname">fileName</td><td>Path to XML file to parse </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, error code on failure </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="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="PUserFcnBase_8h.html">PUserFcnBase.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>