1080 lines
55 KiB
HTML
1080 lines
55 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>musrWiz: PAdmin 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>
|
|
<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" />
|
|
</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">musrWiz<span id="projectnumber"> 0.1.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&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('classPAdmin.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="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#pri-methods">Private Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="classPAdmin-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">PAdmin Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>The <a class="el" href="classPAdmin.html" title="The PAdmin class is the main administration class for musrWiz.">PAdmin</a> class is the main administration class for musrWiz.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="PAdmin_8h_source.html">PAdmin.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for PAdmin:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classPAdmin.png" alt=""/>
|
|
</div></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:a26348be83d7a51fe92c8c9e1338873e6" id="r_a26348be83d7a51fe92c8c9e1338873e6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a26348be83d7a51fe92c8c9e1338873e6">PAdmin</a> ()</td></tr>
|
|
<tr class="memdesc:a26348be83d7a51fe92c8c9e1338873e6"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. Loads all configuration files. <br /></td></tr>
|
|
<tr class="separator:a26348be83d7a51fe92c8c9e1338873e6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a68520fd58170329ec88b437129b4202b" id="r_a68520fd58170329ec88b437129b4202b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a68520fd58170329ec88b437129b4202b">~PAdmin</a> ()</td></tr>
|
|
<tr class="memdesc:a68520fd58170329ec88b437129b4202b"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
|
|
<tr class="separator:a68520fd58170329ec88b437129b4202b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaad5594e8308f0d6ff3e1c3526c2e8cb" id="r_aaad5594e8308f0d6ff3e1c3526c2e8cb"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#aaad5594e8308f0d6ff3e1c3526c2e8cb">IsValid</a> ()</td></tr>
|
|
<tr class="memdesc:aaad5594e8308f0d6ff3e1c3526c2e8cb"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the admin object was initialized successfully. <br /></td></tr>
|
|
<tr class="separator:aaad5594e8308f0d6ff3e1c3526c2e8cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a24cd57e2549240e4cb3c4596d0c85838" id="r_a24cd57e2549240e4cb3c4596d0c85838"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a24cd57e2549240e4cb3c4596d0c85838">dump</a> (int tag)</td></tr>
|
|
<tr class="memdesc:a24cd57e2549240e4cb3c4596d0c85838"><td class="mdescLeft"> </td><td class="mdescRight">Dumps debug information to stdout. <br /></td></tr>
|
|
<tr class="separator:a24cd57e2549240e4cb3c4596d0c85838"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8a6d21a780001e04aa574bf6375a49ed" id="r_a8a6d21a780001e04aa574bf6375a49ed"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8a6d21a780001e04aa574bf6375a49ed">getDefaultInstitute</a> ()</td></tr>
|
|
<tr class="memdesc:a8a6d21a780001e04aa574bf6375a49ed"><td class="mdescLeft"> </td><td class="mdescRight">Returns the default institute name. <br /></td></tr>
|
|
<tr class="separator:a8a6d21a780001e04aa574bf6375a49ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a101e10eaa97dbd18b5d1a77bdcb68abb" id="r_a101e10eaa97dbd18b5d1a77bdcb68abb"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#a101e10eaa97dbd18b5d1a77bdcb68abb">getDefaultInstrument</a> ()</td></tr>
|
|
<tr class="memdesc:a101e10eaa97dbd18b5d1a77bdcb68abb"><td class="mdescLeft"> </td><td class="mdescRight">Returns the default instrument name. <br /></td></tr>
|
|
<tr class="separator:a101e10eaa97dbd18b5d1a77bdcb68abb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a39c27a476646c72533bfeed22a4f7f56" id="r_a39c27a476646c72533bfeed22a4f7f56"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#a39c27a476646c72533bfeed22a4f7f56">getDefaultFitType</a> ()</td></tr>
|
|
<tr class="memdesc:a39c27a476646c72533bfeed22a4f7f56"><td class="mdescLeft"> </td><td class="mdescRight">Returns the default fit type. <br /></td></tr>
|
|
<tr class="separator:a39c27a476646c72533bfeed22a4f7f56"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aab992ae2a9f2be57a5086eaeec840490" id="r_aab992ae2a9f2be57a5086eaeec840490"><td class="memItemLeft" align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#aab992ae2a9f2be57a5086eaeec840490">getInstituteList</a> ()</td></tr>
|
|
<tr class="memdesc:aab992ae2a9f2be57a5086eaeec840490"><td class="mdescLeft"> </td><td class="mdescRight">Returns a list of all available institute names. <br /></td></tr>
|
|
<tr class="separator:aab992ae2a9f2be57a5086eaeec840490"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abab05fd73a15a3d602b7c09321f3bca6" id="r_abab05fd73a15a3d602b7c09321f3bca6"><td class="memItemLeft" align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#abab05fd73a15a3d602b7c09321f3bca6">getInstrumentList</a> (QString institute)</td></tr>
|
|
<tr class="memdesc:abab05fd73a15a3d602b7c09321f3bca6"><td class="mdescLeft"> </td><td class="mdescRight">Returns a list of instruments for a given institute. <br /></td></tr>
|
|
<tr class="separator:abab05fd73a15a3d602b7c09321f3bca6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afc4369f2149dc374f8c7f6d31cc65f35" id="r_afc4369f2149dc374f8c7f6d31cc65f35"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPInstrument.html">PInstrument</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="#afc4369f2149dc374f8c7f6d31cc65f35">getInstrument</a> (QString institute, QString instrument)</td></tr>
|
|
<tr class="memdesc:afc4369f2149dc374f8c7f6d31cc65f35"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to an instrument object. <br /></td></tr>
|
|
<tr class="separator:afc4369f2149dc374f8c7f6d31cc65f35"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a037ef69fa93c00d62ed6bb79c7598695" id="r_a037ef69fa93c00d62ed6bb79c7598695"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a037ef69fa93c00d62ed6bb79c7598695">getTheoTemplateSize</a> ()</td></tr>
|
|
<tr class="memdesc:a037ef69fa93c00d62ed6bb79c7598695"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of theory templates. <br /></td></tr>
|
|
<tr class="separator:a037ef69fa93c00d62ed6bb79c7598695"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af29f6624a5d15de8c4f2254679b4bd87" id="r_af29f6624a5d15de8c4f2254679b4bd87"><td class="memItemLeft" align="right" valign="top">QVector< <a class="el" href="classPTheoTemplate.html">PTheoTemplate</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="#af29f6624a5d15de8c4f2254679b4bd87">getTheoTemplates</a> ()</td></tr>
|
|
<tr class="memdesc:af29f6624a5d15de8c4f2254679b4bd87"><td class="mdescLeft"> </td><td class="mdescRight">Returns all theory templates. <br /></td></tr>
|
|
<tr class="separator:af29f6624a5d15de8c4f2254679b4bd87"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0e56beee97bf8b692f75dde09b0439f3" id="r_a0e56beee97bf8b692f75dde09b0439f3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPTheoTemplate.html">PTheoTemplate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0e56beee97bf8b692f75dde09b0439f3">getTheoTemplate</a> (int idx)</td></tr>
|
|
<tr class="memdesc:a0e56beee97bf8b692f75dde09b0439f3"><td class="mdescLeft"> </td><td class="mdescRight">Returns a theory template by index. <br /></td></tr>
|
|
<tr class="separator:a0e56beee97bf8b692f75dde09b0439f3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aac48723474479dd8bf8f6cb8c88523e4" id="r_aac48723474479dd8bf8f6cb8c88523e4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#aac48723474479dd8bf8f6cb8c88523e4">getMusrfitFuncSize</a> ()</td></tr>
|
|
<tr class="memdesc:aac48723474479dd8bf8f6cb8c88523e4"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of musrfit functions. <br /></td></tr>
|
|
<tr class="separator:aac48723474479dd8bf8f6cb8c88523e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0e6296de6e1994afb419c36d0864122e" id="r_a0e6296de6e1994afb419c36d0864122e"><td class="memItemLeft" align="right" valign="top">QVector< <a class="el" href="classPMusrfitFunc.html">PMusrfitFunc</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0e6296de6e1994afb419c36d0864122e">getMusrfitFunc</a> ()</td></tr>
|
|
<tr class="memdesc:a0e6296de6e1994afb419c36d0864122e"><td class="mdescLeft"> </td><td class="mdescRight">Returns all musrfit functions. <br /></td></tr>
|
|
<tr class="separator:a0e6296de6e1994afb419c36d0864122e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a92a8881fc004f7c50b261f9af795169e" id="r_a92a8881fc004f7c50b261f9af795169e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPMusrfitFunc.html">PMusrfitFunc</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a92a8881fc004f7c50b261f9af795169e">getMusrfitFunc</a> (QString name)</td></tr>
|
|
<tr class="memdesc:a92a8881fc004f7c50b261f9af795169e"><td class="mdescLeft"> </td><td class="mdescRight">Returns a musrfit function by name or abbreviation. <br /></td></tr>
|
|
<tr class="separator:a92a8881fc004f7c50b261f9af795169e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:abc1f684dd27cae1baf3fab1cb688a0b9" id="r_abc1f684dd27cae1baf3fab1cb688a0b9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#abc1f684dd27cae1baf3fab1cb688a0b9">addInstrument</a> (QString institute, <a class="el" href="classPInstrument.html">PInstrument</a> instrument)</td></tr>
|
|
<tr class="memdesc:abc1f684dd27cae1baf3fab1cb688a0b9"><td class="mdescLeft"> </td><td class="mdescRight">Adds an instrument to an institute. <br /></td></tr>
|
|
<tr class="separator:abc1f684dd27cae1baf3fab1cb688a0b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
|
|
Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:a8349feaf916f9efdb5c1263f19d5b7a0" id="r_a8349feaf916f9efdb5c1263f19d5b7a0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8349feaf916f9efdb5c1263f19d5b7a0">loadMusrWizDefault</a> (QString fln)</td></tr>
|
|
<tr class="memdesc:a8349feaf916f9efdb5c1263f19d5b7a0"><td class="mdescLeft"> </td><td class="mdescRight">Loads the musrWiz.xml default settings file. <br /></td></tr>
|
|
<tr class="separator:a8349feaf916f9efdb5c1263f19d5b7a0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab9bfe3e58e4c460fe5a977313ad1c8dd" id="r_ab9bfe3e58e4c460fe5a977313ad1c8dd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab9bfe3e58e4c460fe5a977313ad1c8dd">loadMusrfitFunc</a> (QString fln)</td></tr>
|
|
<tr class="memdesc:ab9bfe3e58e4c460fe5a977313ad1c8dd"><td class="mdescLeft"> </td><td class="mdescRight">Loads the musrfit_funcs.xml file. <br /></td></tr>
|
|
<tr class="separator:ab9bfe3e58e4c460fe5a977313ad1c8dd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7ae5802442b73cf5b01592c31f141637" id="r_a7ae5802442b73cf5b01592c31f141637"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7ae5802442b73cf5b01592c31f141637">loadInstrumentDef</a> (QString path, QString fln)</td></tr>
|
|
<tr class="memdesc:a7ae5802442b73cf5b01592c31f141637"><td class="mdescLeft"> </td><td class="mdescRight">Loads an instrument definition XML file. <br /></td></tr>
|
|
<tr class="separator:a7ae5802442b73cf5b01592c31f141637"><td class="memSeparator" colspan="2"> </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:a2584c56be1b93c48494fa0defd054c8d" id="r_a2584c56be1b93c48494fa0defd054c8d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2584c56be1b93c48494fa0defd054c8d">fValid</a></td></tr>
|
|
<tr class="memdesc:a2584c56be1b93c48494fa0defd054c8d"><td class="mdescLeft"> </td><td class="mdescRight">flag indicating successful initialization <br /></td></tr>
|
|
<tr class="separator:a2584c56be1b93c48494fa0defd054c8d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3527c85b4a575d5bd3adb0396275dd90" id="r_a3527c85b4a575d5bd3adb0396275dd90"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPMusrWizDefault.html">PMusrWizDefault</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3527c85b4a575d5bd3adb0396275dd90">fDefault</a></td></tr>
|
|
<tr class="memdesc:a3527c85b4a575d5bd3adb0396275dd90"><td class="mdescLeft"> </td><td class="mdescRight">default wizard settings <br /></td></tr>
|
|
<tr class="separator:a3527c85b4a575d5bd3adb0396275dd90"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6dd0a70a12002db8b232e783f3ea072d" id="r_a6dd0a70a12002db8b232e783f3ea072d"><td class="memItemLeft" align="right" valign="top">QVector< <a class="el" href="classPInstitute.html">PInstitute</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6dd0a70a12002db8b232e783f3ea072d">fInstitute</a></td></tr>
|
|
<tr class="memdesc:a6dd0a70a12002db8b232e783f3ea072d"><td class="mdescLeft"> </td><td class="mdescRight">list of institutes with their instruments <br /></td></tr>
|
|
<tr class="separator:a6dd0a70a12002db8b232e783f3ea072d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac3e9c2b6d3d893515cce7e71bbc140fc" id="r_ac3e9c2b6d3d893515cce7e71bbc140fc"><td class="memItemLeft" align="right" valign="top">QVector< <a class="el" href="classPTheoTemplate.html">PTheoTemplate</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac3e9c2b6d3d893515cce7e71bbc140fc">fTheoTemplate</a></td></tr>
|
|
<tr class="memdesc:ac3e9c2b6d3d893515cce7e71bbc140fc"><td class="mdescLeft"> </td><td class="mdescRight">list of theory templates <br /></td></tr>
|
|
<tr class="separator:ac3e9c2b6d3d893515cce7e71bbc140fc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acd01fdc4c16e0e22ddebe523a37b3f12" id="r_acd01fdc4c16e0e22ddebe523a37b3f12"><td class="memItemLeft" align="right" valign="top">QVector< <a class="el" href="classPMusrfitFunc.html">PMusrfitFunc</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="#acd01fdc4c16e0e22ddebe523a37b3f12">fMusrfitFunc</a></td></tr>
|
|
<tr class="memdesc:acd01fdc4c16e0e22ddebe523a37b3f12"><td class="mdescLeft"> </td><td class="mdescRight">list of musrfit functions <br /></td></tr>
|
|
<tr class="separator:acd01fdc4c16e0e22ddebe523a37b3f12"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:a09464be8302897327f9ea74b90e55b7f" id="r_a09464be8302897327f9ea74b90e55b7f"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="#a09464be8302897327f9ea74b90e55b7f">PFuncXMLParser</a></td></tr>
|
|
<tr class="separator:a09464be8302897327f9ea74b90e55b7f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a27cac88a70cf6e149c6544ff3ef4d73d" id="r_a27cac88a70cf6e149c6544ff3ef4d73d"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="#a27cac88a70cf6e149c6544ff3ef4d73d">PInstrumentDefXMLParser</a></td></tr>
|
|
<tr class="separator:a27cac88a70cf6e149c6544ff3ef4d73d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af1be044375687ef9b270f2ae4a075289" id="r_af1be044375687ef9b270f2ae4a075289"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="#af1be044375687ef9b270f2ae4a075289">PMusrWizDefaultXMLParser</a></td></tr>
|
|
<tr class="separator:af1be044375687ef9b270f2ae4a075289"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>The <a class="el" href="classPAdmin.html" title="The PAdmin class is the main administration class for musrWiz.">PAdmin</a> class is the main administration class for musrWiz. </p>
|
|
<p>This class serves as the central repository for all configuration data needed by the musrWiz application. It loads and manages:</p><ul>
|
|
<li>Default wizard settings from musrWiz.xml</li>
|
|
<li>Musrfit function definitions and theory templates from musrfit_funcs.xml</li>
|
|
<li>Instrument definitions from instrument_def_*.xml files</li>
|
|
</ul>
|
|
<p>The XML parser friend classes populate this class with data from the configuration files. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a26348be83d7a51fe92c8c9e1338873e6" name="a26348be83d7a51fe92c8c9e1338873e6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a26348be83d7a51fe92c8c9e1338873e6">◆ </a></span>PAdmin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">PAdmin::PAdmin </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructor. Loads all configuration files. </p>
|
|
<p>Attempts to load configuration files first from the local directory, then from $HOME/.musrfit/musrWiz/. If files don't exist, creates them from built-in resources.</p>
|
|
<p>Initializes that <a class="el" href="classPAdmin.html" title="The PAdmin class is the main administration class for musrWiz.">PAdmin</a> object, and calls the XML parser which feeds the object variables. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a68520fd58170329ec88b437129b4202b" name="a68520fd58170329ec88b437129b4202b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a68520fd58170329ec88b437129b4202b">◆ </a></span>~PAdmin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">PAdmin::~PAdmin </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></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>Destructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="abc1f684dd27cae1baf3fab1cb688a0b9" name="abc1f684dd27cae1baf3fab1cb688a0b9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abc1f684dd27cae1baf3fab1cb688a0b9">◆ </a></span>addInstrument()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int PAdmin::addInstrument </td>
|
|
<td>(</td>
|
|
<td class="paramtype">QString</td> <td class="paramname"><span class="paramname"><em>institute</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classPInstrument.html">PInstrument</a></td> <td class="paramname"><span class="paramname"><em>instrument</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel protected">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Adds an instrument to an institute. </p>
|
|
<p><a class="el" href="#abc1f684dd27cae1baf3fab1cb688a0b9" title="Adds an instrument to an institute.">PAdmin::addInstrument</a> adds an instrument to an institute.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">institute</td><td>Institute name. Creates the institute if it doesn't exist. </td></tr>
|
|
<tr><td class="paramname">instrument</td><td>Instrument object to add. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 on success.</dd></dl>
|
|
<p>Searches for the specified institute. If found, adds the instrument to it. If the institute doesn't exist, creates a new institute entry and adds the instrument to it.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">institute</td><td>Institute name (e.g., "PSI"). </td></tr>
|
|
<tr><td class="paramname">instrument</td><td>Instrument object to add. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 on success. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a24cd57e2549240e4cb3c4596d0c85838" name="a24cd57e2549240e4cb3c4596d0c85838"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a24cd57e2549240e4cb3c4596d0c85838">◆ </a></span>dump()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PAdmin::dump </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>tag</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Dumps debug information to stdout. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">tag</td><td>Debug tag: 0=instrument defs, 1=musrfit funcs, 2=both, -1=none.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>dump all the instrument defs to stdout. This routine is there for debug purposes only. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a39c27a476646c72533bfeed22a4f7f56" name="a39c27a476646c72533bfeed22a4f7f56"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a39c27a476646c72533bfeed22a4f7f56">◆ </a></span>getDefaultFitType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PAdmin::getDefaultFitType </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></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>Returns the default fit type. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Default fit type string from musrWiz.xml. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8a6d21a780001e04aa574bf6375a49ed" name="a8a6d21a780001e04aa574bf6375a49ed"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8a6d21a780001e04aa574bf6375a49ed">◆ </a></span>getDefaultInstitute()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PAdmin::getDefaultInstitute </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></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>Returns the default institute name. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Default institute name from musrWiz.xml. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a101e10eaa97dbd18b5d1a77bdcb68abb" name="a101e10eaa97dbd18b5d1a77bdcb68abb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a101e10eaa97dbd18b5d1a77bdcb68abb">◆ </a></span>getDefaultInstrument()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PAdmin::getDefaultInstrument </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></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>Returns the default instrument name. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Default instrument name from musrWiz.xml. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aab992ae2a9f2be57a5086eaeec840490" name="aab992ae2a9f2be57a5086eaeec840490"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aab992ae2a9f2be57a5086eaeec840490">◆ </a></span>getInstituteList()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QStringList PAdmin::getInstituteList </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a list of all available institute names. </p>
|
|
<p><a class="el" href="#aab992ae2a9f2be57a5086eaeec840490" title="Returns a list of all available institute names.">PAdmin::getInstituteList</a> returns a list of all available institute names.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>QStringList containing all institute names.</dd></dl>
|
|
<p>Iterates through all loaded institutes and collects their names into a QStringList.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>QStringList containing all institute names (e.g., "PSI", "TRIUMF", "ISIS", "J-PARC"). </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afc4369f2149dc374f8c7f6d31cc65f35" name="afc4369f2149dc374f8c7f6d31cc65f35"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afc4369f2149dc374f8c7f6d31cc65f35">◆ </a></span>getInstrument()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classPInstrument.html">PInstrument</a> * PAdmin::getInstrument </td>
|
|
<td>(</td>
|
|
<td class="paramtype">QString</td> <td class="paramname"><span class="paramname"><em>institute</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">QString</td> <td class="paramname"><span class="paramname"><em>instrument</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a pointer to an instrument object. </p>
|
|
<p><a class="el" href="#afc4369f2149dc374f8c7f6d31cc65f35" title="Returns a pointer to an instrument object.">PAdmin::getInstrument</a> returns a pointer to an instrument object.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">institute</td><td>Institute name. </td></tr>
|
|
<tr><td class="paramname">instrument</td><td>Instrument name. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Pointer to <a class="el" href="classPInstrument.html" title="The PInstrument class represents a muon spectrometer instrument.">PInstrument</a>, or nullptr if not found.</dd></dl>
|
|
<p>Searches for the specified institute and instrument combination.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">institute</td><td>Institute name (e.g., "PSI"). </td></tr>
|
|
<tr><td class="paramname">instrument</td><td>Instrument name (e.g., "HAL9500"). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Pointer to the <a class="el" href="classPInstrument.html" title="The PInstrument class represents a muon spectrometer instrument.">PInstrument</a> object, or nullptr if not found. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abab05fd73a15a3d602b7c09321f3bca6" name="abab05fd73a15a3d602b7c09321f3bca6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abab05fd73a15a3d602b7c09321f3bca6">◆ </a></span>getInstrumentList()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QStringList PAdmin::getInstrumentList </td>
|
|
<td>(</td>
|
|
<td class="paramtype">QString</td> <td class="paramname"><span class="paramname"><em>institute</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a list of instruments for a given institute. </p>
|
|
<p><a class="el" href="#abab05fd73a15a3d602b7c09321f3bca6" title="Returns a list of instruments for a given institute.">PAdmin::getInstrumentList</a> returns a list of instruments for a given institute.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">institute</td><td>Institute name to query. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>QStringList containing all instrument names for the institute.</dd></dl>
|
|
<p>Searches for the specified institute and returns the names of all instruments associated with it.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">institute</td><td>Institute name to query (e.g., "PSI"). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>QStringList containing instrument names, or empty list if institute not found. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0e6296de6e1994afb419c36d0864122e" name="a0e6296de6e1994afb419c36d0864122e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0e6296de6e1994afb419c36d0864122e">◆ </a></span>getMusrfitFunc() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QVector< <a class="el" href="classPMusrfitFunc.html">PMusrfitFunc</a> > PAdmin::getMusrfitFunc </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></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>Returns all musrfit functions. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>QVector containing all <a class="el" href="classPMusrfitFunc.html" title="The PMusrfitFunc class represents a musrfit theory function.">PMusrfitFunc</a> objects. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a92a8881fc004f7c50b261f9af795169e" name="a92a8881fc004f7c50b261f9af795169e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a92a8881fc004f7c50b261f9af795169e">◆ </a></span>getMusrfitFunc() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classPMusrfitFunc.html">PMusrfitFunc</a> PAdmin::getMusrfitFunc </td>
|
|
<td>(</td>
|
|
<td class="paramtype">QString</td> <td class="paramname"><span class="paramname"><em>name</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a musrfit function by name or abbreviation. </p>
|
|
<p><a class="el" href="#a0e6296de6e1994afb419c36d0864122e" title="Returns all musrfit functions.">PAdmin::getMusrfitFunc</a> returns a musrfit function by name or abbreviation.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>Function name or abbreviation. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classPMusrfitFunc.html" title="The PMusrfitFunc class represents a musrfit theory function.">PMusrfitFunc</a> matching the name, or default func if not found.</dd></dl>
|
|
<p>Searches the list of loaded musrfit functions for one matching the given name (either full name or abbreviation).</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>Function name (e.g., "simpleGss") or abbreviation (e.g., "sg"). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classPMusrfitFunc.html" title="The PMusrfitFunc class represents a musrfit theory function.">PMusrfitFunc</a> matching the name, or a default/empty function if not found. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aac48723474479dd8bf8f6cb8c88523e4" name="aac48723474479dd8bf8f6cb8c88523e4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aac48723474479dd8bf8f6cb8c88523e4">◆ </a></span>getMusrfitFuncSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int PAdmin::getMusrfitFuncSize </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></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>Returns the number of musrfit functions. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of musrfit functions. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0e56beee97bf8b692f75dde09b0439f3" name="a0e56beee97bf8b692f75dde09b0439f3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0e56beee97bf8b692f75dde09b0439f3">◆ </a></span>getTheoTemplate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classPTheoTemplate.html">PTheoTemplate</a> PAdmin::getTheoTemplate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>idx</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a theory template by index. </p>
|
|
<p><a class="el" href="#a0e56beee97bf8b692f75dde09b0439f3" title="Returns a theory template by index.">PAdmin::getTheoTemplate</a> returns a theory template by index.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">idx</td><td>Index of the template. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classPTheoTemplate.html">PTheoTemplate</a> at the given index, or empty template if out of range.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">idx</td><td>Index of the requested theory template. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classPTheoTemplate.html">PTheoTemplate</a> at the given index, or an empty/default template if index is out of range. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af29f6624a5d15de8c4f2254679b4bd87" name="af29f6624a5d15de8c4f2254679b4bd87"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af29f6624a5d15de8c4f2254679b4bd87">◆ </a></span>getTheoTemplates()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QVector< <a class="el" href="classPTheoTemplate.html">PTheoTemplate</a> > PAdmin::getTheoTemplates </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></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>Returns all theory templates. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>QVector containing all <a class="el" href="classPTheoTemplate.html">PTheoTemplate</a> objects. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a037ef69fa93c00d62ed6bb79c7598695" name="a037ef69fa93c00d62ed6bb79c7598695"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a037ef69fa93c00d62ed6bb79c7598695">◆ </a></span>getTheoTemplateSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int PAdmin::getTheoTemplateSize </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></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>Returns the number of theory templates. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of theory templates. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaad5594e8308f0d6ff3e1c3526c2e8cb" name="aaad5594e8308f0d6ff3e1c3526c2e8cb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaad5594e8308f0d6ff3e1c3526c2e8cb">◆ </a></span>IsValid()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool PAdmin::IsValid </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></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>Checks if the admin object was initialized successfully. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if all required configuration files were loaded, false otherwise. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7ae5802442b73cf5b01592c31f141637" name="a7ae5802442b73cf5b01592c31f141637"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7ae5802442b73cf5b01592c31f141637">◆ </a></span>loadInstrumentDef()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int PAdmin::loadInstrumentDef </td>
|
|
<td>(</td>
|
|
<td class="paramtype">QString</td> <td class="paramname"><span class="paramname"><em>path</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">QString</td> <td class="paramname"><span class="paramname"><em>fln</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Loads an instrument definition XML file. </p>
|
|
<p><a class="el" href="#a7ae5802442b73cf5b01592c31f141637" title="Loads an instrument definition XML file.">PAdmin::loadInstrumentDef</a> loads an instrument definition XML file.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">path</td><td>Directory path containing the file. </td></tr>
|
|
<tr><td class="paramname">fln</td><td>Filename of the instrument definition file. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 on success, 1 on failure.</dd></dl>
|
|
<p>If the file doesn't exist at the specified path, copies the default from the built-in Qt resource system to $HOME/.musrfit/musrWiz/.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">path</td><td>Directory path containing the file. </td></tr>
|
|
<tr><td class="paramname">fln</td><td>Filename of the instrument definition file (e.g., "instrument_def_psi.xml"). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 on success, 1 on failure. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab9bfe3e58e4c460fe5a977313ad1c8dd" name="ab9bfe3e58e4c460fe5a977313ad1c8dd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab9bfe3e58e4c460fe5a977313ad1c8dd">◆ </a></span>loadMusrfitFunc()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int PAdmin::loadMusrfitFunc </td>
|
|
<td>(</td>
|
|
<td class="paramtype">QString</td> <td class="paramname"><span class="paramname"><em>fln</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Loads the musrfit_funcs.xml file. </p>
|
|
<p><a class="el" href="#ab9bfe3e58e4c460fe5a977313ad1c8dd" title="Loads the musrfit_funcs.xml file.">PAdmin::loadMusrfitFunc</a> loads the musrfit_funcs.xml file.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fln</td><td>Path to the file. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 on success, 1 on failure.</dd></dl>
|
|
<p>If the file doesn't exist at the specified path, copies the default from the built-in Qt resource system to $HOME/.musrfit/musrWiz/.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fln</td><td>Path to the musrfit_funcs.xml file. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 on success, 1 on failure. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8349feaf916f9efdb5c1263f19d5b7a0" name="a8349feaf916f9efdb5c1263f19d5b7a0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8349feaf916f9efdb5c1263f19d5b7a0">◆ </a></span>loadMusrWizDefault()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int PAdmin::loadMusrWizDefault </td>
|
|
<td>(</td>
|
|
<td class="paramtype">QString</td> <td class="paramname"><span class="paramname"><em>fln</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Loads the musrWiz.xml default settings file. </p>
|
|
<p><a class="el" href="#a8349feaf916f9efdb5c1263f19d5b7a0" title="Loads the musrWiz.xml default settings file.">PAdmin::loadMusrWizDefault</a> loads the musrWiz.xml default settings file.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fln</td><td>Path to the file. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 on success, 1 on failure.</dd></dl>
|
|
<p>If the file doesn't exist at the specified path, copies the default from the built-in Qt resource system to $HOME/.musrfit/musrWiz/.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fln</td><td>Path to the musrWiz.xml file. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 on success, 1 on failure. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
|
|
<a id="a09464be8302897327f9ea74b90e55b7f" name="a09464be8302897327f9ea74b90e55b7f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a09464be8302897327f9ea74b90e55b7f">◆ </a></span>PFuncXMLParser</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">friend class <a class="el" href="classPFuncXMLParser.html">PFuncXMLParser</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel friend">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a27cac88a70cf6e149c6544ff3ef4d73d" name="a27cac88a70cf6e149c6544ff3ef4d73d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a27cac88a70cf6e149c6544ff3ef4d73d">◆ </a></span>PInstrumentDefXMLParser</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">friend class <a class="el" href="classPInstrumentDefXMLParser.html">PInstrumentDefXMLParser</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel friend">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af1be044375687ef9b270f2ae4a075289" name="af1be044375687ef9b270f2ae4a075289"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af1be044375687ef9b270f2ae4a075289">◆ </a></span>PMusrWizDefaultXMLParser</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">friend class <a class="el" href="classPMusrWizDefaultXMLParser.html">PMusrWizDefaultXMLParser</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel friend">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a3527c85b4a575d5bd3adb0396275dd90" name="a3527c85b4a575d5bd3adb0396275dd90"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3527c85b4a575d5bd3adb0396275dd90">◆ </a></span>fDefault</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="classPMusrWizDefault.html">PMusrWizDefault</a> PAdmin::fDefault</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>default wizard settings </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6dd0a70a12002db8b232e783f3ea072d" name="a6dd0a70a12002db8b232e783f3ea072d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6dd0a70a12002db8b232e783f3ea072d">◆ </a></span>fInstitute</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QVector<<a class="el" href="classPInstitute.html">PInstitute</a>> PAdmin::fInstitute</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>list of institutes with their instruments </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acd01fdc4c16e0e22ddebe523a37b3f12" name="acd01fdc4c16e0e22ddebe523a37b3f12"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acd01fdc4c16e0e22ddebe523a37b3f12">◆ </a></span>fMusrfitFunc</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QVector<<a class="el" href="classPMusrfitFunc.html">PMusrfitFunc</a>> PAdmin::fMusrfitFunc</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>list of musrfit functions </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac3e9c2b6d3d893515cce7e71bbc140fc" name="ac3e9c2b6d3d893515cce7e71bbc140fc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac3e9c2b6d3d893515cce7e71bbc140fc">◆ </a></span>fTheoTemplate</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QVector<<a class="el" href="classPTheoTemplate.html">PTheoTemplate</a>> PAdmin::fTheoTemplate</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>list of theory templates </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2584c56be1b93c48494fa0defd054c8d" name="a2584c56be1b93c48494fa0defd054c8d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2584c56be1b93c48494fa0defd054c8d">◆ </a></span>fValid</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool PAdmin::fValid</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>flag indicating successful initialization </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>/workspace/LMU/musrfit/src/musredit_qt6/musrWiz/<a class="el" href="PAdmin_8h_source.html">PAdmin.h</a></li>
|
|
<li>/workspace/LMU/musrfit/src/musredit_qt6/musrWiz/<a class="el" href="PAdmin_8cpp.html">PAdmin.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="classPAdmin.html">PAdmin</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>
|