Files
musrfit/mupp/html/classPmuppXY.html
T
2026-07-29 11:05:16 +00:00

774 lines
38 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>mupp: PmuppXY 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="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">mupp<span id="projectnumber">&#160;1.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&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<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('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classPmuppXY-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">PmuppXY Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Data structure for X-Y axis label associations.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="PmuppGui_8h_source.html">PmuppGui.h</a>&gt;</code></p>
<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:abb32540811266f2af752db35a949d1bb" id="r_abb32540811266f2af752db35a949d1bb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abb32540811266f2af752db35a949d1bb">PmuppXY</a> ()</td></tr>
<tr class="memdesc:abb32540811266f2af752db35a949d1bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. Initializes with invalid collection tag. <br /></td></tr>
<tr class="separator:abb32540811266f2af752db35a949d1bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03a7a36c748d33e8f998148e94d5e777" id="r_a03a7a36c748d33e8f998148e94d5e777"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a03a7a36c748d33e8f998148e94d5e777">setCollectionTag</a> (int tag)</td></tr>
<tr class="memdesc:a03a7a36c748d33e8f998148e94d5e777"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the collection tag (identifier). <br /></td></tr>
<tr class="separator:a03a7a36c748d33e8f998148e94d5e777"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adab5e005819fd4429907792dcfd7e8ee" id="r_adab5e005819fd4429907792dcfd7e8ee"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adab5e005819fd4429907792dcfd7e8ee">setXlabel</a> (QString str)</td></tr>
<tr class="memdesc:adab5e005819fd4429907792dcfd7e8ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the X-axis label. <br /></td></tr>
<tr class="separator:adab5e005819fd4429907792dcfd7e8ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a654ed144fe445ded54177f1b1aad43c3" id="r_a654ed144fe445ded54177f1b1aad43c3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a654ed144fe445ded54177f1b1aad43c3">addYlabel</a> (QString str)</td></tr>
<tr class="memdesc:a654ed144fe445ded54177f1b1aad43c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a Y-axis label to the list. <br /></td></tr>
<tr class="separator:a654ed144fe445ded54177f1b1aad43c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70b55cc521b5bb2af9b826270c90b76f" id="r_a70b55cc521b5bb2af9b826270c90b76f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a70b55cc521b5bb2af9b826270c90b76f">setYlabel</a> (int idx, QString str)</td></tr>
<tr class="memdesc:a70b55cc521b5bb2af9b826270c90b76f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the Y-axis label at a specific index. <br /></td></tr>
<tr class="separator:a70b55cc521b5bb2af9b826270c90b76f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a971a6757b15b7c535148afedbc267697" id="r_a971a6757b15b7c535148afedbc267697"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a971a6757b15b7c535148afedbc267697">removeYlabel</a> (int idx)</td></tr>
<tr class="memdesc:a971a6757b15b7c535148afedbc267697"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes a Y-axis label by index. <br /></td></tr>
<tr class="separator:a971a6757b15b7c535148afedbc267697"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d4c456d7d0e320e112aaaadd7b78152" id="r_a3d4c456d7d0e320e112aaaadd7b78152"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3d4c456d7d0e320e112aaaadd7b78152">removeYlabel</a> (QString str)</td></tr>
<tr class="memdesc:a3d4c456d7d0e320e112aaaadd7b78152"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes a Y-axis label by name. <br /></td></tr>
<tr class="separator:a3d4c456d7d0e320e112aaaadd7b78152"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01c676fd68ff3f8e566b61d83541c809" id="r_a01c676fd68ff3f8e566b61d83541c809"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a01c676fd68ff3f8e566b61d83541c809">getCollectionTag</a> ()</td></tr>
<tr class="memdesc:a01c676fd68ff3f8e566b61d83541c809"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the collection tag. <br /></td></tr>
<tr class="separator:a01c676fd68ff3f8e566b61d83541c809"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb162ea9cb5a8edab6f61edf4edb841c" id="r_acb162ea9cb5a8edab6f61edf4edb841c"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acb162ea9cb5a8edab6f61edf4edb841c">getXlabel</a> ()</td></tr>
<tr class="memdesc:acb162ea9cb5a8edab6f61edf4edb841c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the X-axis label. <br /></td></tr>
<tr class="separator:acb162ea9cb5a8edab6f61edf4edb841c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22219ceac0bd49211e670e6d2541e879" id="r_a22219ceac0bd49211e670e6d2541e879"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a22219ceac0bd49211e670e6d2541e879">getXlabelIdx</a> ()</td></tr>
<tr class="memdesc:a22219ceac0bd49211e670e6d2541e879"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extracts the parameter index from the X-axis label. <br /></td></tr>
<tr class="separator:a22219ceac0bd49211e670e6d2541e879"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4794621e2f528ad0d19fc57c668bcad" id="r_ae4794621e2f528ad0d19fc57c668bcad"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae4794621e2f528ad0d19fc57c668bcad">getYlabelSize</a> ()</td></tr>
<tr class="memdesc:ae4794621e2f528ad0d19fc57c668bcad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the number of Y-axis labels. <br /></td></tr>
<tr class="separator:ae4794621e2f528ad0d19fc57c668bcad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8bc2ed7559e2446e8d94decee7b890d" id="r_ac8bc2ed7559e2446e8d94decee7b890d"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac8bc2ed7559e2446e8d94decee7b890d">getYlabel</a> (int idx)</td></tr>
<tr class="memdesc:ac8bc2ed7559e2446e8d94decee7b890d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a Y-axis label by index. <br /></td></tr>
<tr class="separator:ac8bc2ed7559e2446e8d94decee7b890d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74d17f50723aca02870bde8644ff4df1" id="r_a74d17f50723aca02870bde8644ff4df1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a74d17f50723aca02870bde8644ff4df1">getYlabelIdx</a> (int idx)</td></tr>
<tr class="memdesc:a74d17f50723aca02870bde8644ff4df1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extracts the parameter index from a Y-axis label. <br /></td></tr>
<tr class="separator:a74d17f50723aca02870bde8644ff4df1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3868df60cb8c4c48cc5182bbaecf4f3" id="r_ae3868df60cb8c4c48cc5182bbaecf4f3"><td class="memItemLeft" align="right" valign="top">QVector&lt; QString &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae3868df60cb8c4c48cc5182bbaecf4f3">getYlabels</a> ()</td></tr>
<tr class="memdesc:ae3868df60cb8c4c48cc5182bbaecf4f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets all Y-axis labels. <br /></td></tr>
<tr class="separator:ae3868df60cb8c4c48cc5182bbaecf4f3"><td class="memSeparator" colspan="2">&#160;</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:ab753f45e4c45e9f4ec5cc46c6fa85c53" id="r_ab753f45e4c45e9f4ec5cc46c6fa85c53"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab753f45e4c45e9f4ec5cc46c6fa85c53">init</a> ()</td></tr>
<tr class="memdesc:ab753f45e4c45e9f4ec5cc46c6fa85c53"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the object to default state. <br /></td></tr>
<tr class="separator:ab753f45e4c45e9f4ec5cc46c6fa85c53"><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:adfbfb2f66129db7b0a193d457a53a70b" id="r_adfbfb2f66129db7b0a193d457a53a70b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adfbfb2f66129db7b0a193d457a53a70b">fCollectionTag</a></td></tr>
<tr class="memdesc:adfbfb2f66129db7b0a193d457a53a70b"><td class="mdescLeft">&#160;</td><td class="mdescRight">identifier for the associated data collection <br /></td></tr>
<tr class="separator:adfbfb2f66129db7b0a193d457a53a70b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3fd2c85d0245d1d98dd5756147363886" id="r_a3fd2c85d0245d1d98dd5756147363886"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3fd2c85d0245d1d98dd5756147363886">fXlabel</a></td></tr>
<tr class="memdesc:a3fd2c85d0245d1d98dd5756147363886"><td class="mdescLeft">&#160;</td><td class="mdescRight">X-axis parameter label. <br /></td></tr>
<tr class="separator:a3fd2c85d0245d1d98dd5756147363886"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef143d2d88116dbc3f6cca6c22b018cf" id="r_aef143d2d88116dbc3f6cca6c22b018cf"><td class="memItemLeft" align="right" valign="top">QVector&lt; QString &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aef143d2d88116dbc3f6cca6c22b018cf">fYlabel</a></td></tr>
<tr class="memdesc:aef143d2d88116dbc3f6cca6c22b018cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">vector of Y-axis parameter labels <br /></td></tr>
<tr class="separator:aef143d2d88116dbc3f6cca6c22b018cf"><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>Data structure for X-Y axis label associations. </p>
<p><a class="el" href="classPmuppXY.html" title="Data structure for X-Y axis label associations.">PmuppXY</a> stores the relationship between X-axis and Y-axis parameter labels for plotting. Each instance represents one plot configuration with:</p><ul>
<li>One X-axis parameter (independent variable)</li>
<li>Multiple Y-axis parameters (dependent variables)</li>
<li>Association with a specific data collection</li>
</ul>
<p>The class supports:</p><ul>
<li>Managing multiple Y-labels for a single X-label</li>
<li>Extracting parameter indices from formatted label strings</li>
<li>Dynamic addition/removal of Y-axis parameters </li>
</ul>
<p class="definition">Definition at line <a class="el" href="PmuppGui_8h_source.html#l00100">100</a> of file <a class="el" href="PmuppGui_8h_source.html">PmuppGui.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="abb32540811266f2af752db35a949d1bb" name="abb32540811266f2af752db35a949d1bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb32540811266f2af752db35a949d1bb">&#9670;&#160;</a></span>PmuppXY()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">PmuppXY::PmuppXY </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>Default constructor. Initializes with invalid collection tag. </p>
<p class="definition">Definition at line <a class="el" href="PmuppGui_8h_source.html#l00106">106</a> of file <a class="el" href="PmuppGui_8h_source.html">PmuppGui.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a654ed144fe445ded54177f1b1aad43c3" name="a654ed144fe445ded54177f1b1aad43c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a654ed144fe445ded54177f1b1aad43c3">&#9670;&#160;</a></span>addYlabel()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void PmuppXY::addYlabel </td>
<td>(</td>
<td class="paramtype">QString</td> <td class="paramname"><span class="paramname"><em>str</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>Adds a Y-axis label to the list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>Y-axis parameter label to add </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PmuppGui_8h_source.html#l00124">124</a> of file <a class="el" href="PmuppGui_8h_source.html">PmuppGui.h</a>.</p>
</div>
</div>
<a id="a01c676fd68ff3f8e566b61d83541c809" name="a01c676fd68ff3f8e566b61d83541c809"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01c676fd68ff3f8e566b61d83541c809">&#9670;&#160;</a></span>getCollectionTag()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int PmuppXY::getCollectionTag </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>Gets the collection tag. </p>
<dl class="section return"><dt>Returns</dt><dd>collection identifier </dd></dl>
<p class="definition">Definition at line <a class="el" href="PmuppGui_8h_source.html#l00149">149</a> of file <a class="el" href="PmuppGui_8h_source.html">PmuppGui.h</a>.</p>
</div>
</div>
<a id="acb162ea9cb5a8edab6f61edf4edb841c" name="acb162ea9cb5a8edab6f61edf4edb841c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb162ea9cb5a8edab6f61edf4edb841c">&#9670;&#160;</a></span>getXlabel()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QString PmuppXY::getXlabel </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>Gets the X-axis label. </p>
<dl class="section return"><dt>Returns</dt><dd>X-axis parameter label </dd></dl>
<p class="definition">Definition at line <a class="el" href="PmuppGui_8h_source.html#l00155">155</a> of file <a class="el" href="PmuppGui_8h_source.html">PmuppGui.h</a>.</p>
</div>
</div>
<a id="a22219ceac0bd49211e670e6d2541e879" name="a22219ceac0bd49211e670e6d2541e879"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22219ceac0bd49211e670e6d2541e879">&#9670;&#160;</a></span>getXlabelIdx()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int PmuppXY::getXlabelIdx </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts the parameter index from the X-axis label. </p>
<dl class="section return"><dt>Returns</dt><dd>parameter index, or -1 on error</dd></dl>
<p>Parameter labels are formatted as "name (-index-)" where index is the parameter number. This method parses the label string to extract the numeric index value.</p>
<p>The parsing process:</p><ol type="1">
<li>Finds the closing marker "-)"</li>
<li>Finds the opening marker "(-"</li>
<li>Extracts the numeric string between them</li>
<li>Converts to integer</li>
</ol>
<dl class="section return"><dt>Returns</dt><dd>parameter index on success, -1 on parsing error or invalid format </dd></dl>
<p class="definition">Definition at line <a class="el" href="PmuppGui_8cpp_source.html#l00205">205</a> of file <a class="el" href="PmuppGui_8cpp_source.html">PmuppGui.cpp</a>.</p>
</div>
</div>
<a id="ac8bc2ed7559e2446e8d94decee7b890d" name="ac8bc2ed7559e2446e8d94decee7b890d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8bc2ed7559e2446e8d94decee7b890d">&#9670;&#160;</a></span>getYlabel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString PmuppXY::getYlabel </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>Gets a Y-axis label by index. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">idx</td><td>index of the Y-label </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Y-axis parameter label, or empty string if invalid index</dd></dl>
<p>Returns the Y-axis parameter label at the specified position. If the index is out of bounds, returns an empty string instead of causing an error.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">idx</td><td>zero-based index of the Y-label to retrieve</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Y-axis label string if valid index, empty string otherwise </dd></dl>
<p class="definition">Definition at line <a class="el" href="PmuppGui_8cpp_source.html#l00181">181</a> of file <a class="el" href="PmuppGui_8cpp_source.html">PmuppGui.cpp</a>.</p>
</div>
</div>
<a id="a74d17f50723aca02870bde8644ff4df1" name="a74d17f50723aca02870bde8644ff4df1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74d17f50723aca02870bde8644ff4df1">&#9670;&#160;</a></span>getYlabelIdx()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int PmuppXY::getYlabelIdx </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>Extracts the parameter index from a Y-axis label. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">idx</td><td>index of the Y-label </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>parameter index, or -1 on error</dd></dl>
<p>Similar to <a class="el" href="#a22219ceac0bd49211e670e6d2541e879" title="Extracts the parameter index from the X-axis label.">getXlabelIdx()</a>, this method parses a Y-axis label formatted as "name (-index-)" to extract the parameter number. The method first validates that the requested Y-label exists in the vector.</p>
<p>The parsing process:</p><ol type="1">
<li>Validates the Y-label index is in range</li>
<li>Finds the closing marker "-)"</li>
<li>Finds the opening marker "(-"</li>
<li>Extracts the numeric string between them</li>
<li>Converts to integer</li>
</ol>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">idx</td><td>zero-based index of the Y-label to process</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>parameter index on success, -1 on error or invalid format </dd></dl>
<p class="definition">Definition at line <a class="el" href="PmuppGui_8cpp_source.html#l00249">249</a> of file <a class="el" href="PmuppGui_8cpp_source.html">PmuppGui.cpp</a>.</p>
</div>
</div>
<a id="ae3868df60cb8c4c48cc5182bbaecf4f3" name="ae3868df60cb8c4c48cc5182bbaecf4f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3868df60cb8c4c48cc5182bbaecf4f3">&#9670;&#160;</a></span>getYlabels()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QVector&lt; QString &gt; PmuppXY::getYlabels </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>Gets all Y-axis labels. </p>
<dl class="section return"><dt>Returns</dt><dd>vector of all Y-axis parameter labels </dd></dl>
<p class="definition">Definition at line <a class="el" href="PmuppGui_8h_source.html#l00187">187</a> of file <a class="el" href="PmuppGui_8h_source.html">PmuppGui.h</a>.</p>
</div>
</div>
<a id="ae4794621e2f528ad0d19fc57c668bcad" name="ae4794621e2f528ad0d19fc57c668bcad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4794621e2f528ad0d19fc57c668bcad">&#9670;&#160;</a></span>getYlabelSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int PmuppXY::getYlabelSize </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>Gets the number of Y-axis labels. </p>
<dl class="section return"><dt>Returns</dt><dd>count of Y-labels </dd></dl>
<p class="definition">Definition at line <a class="el" href="PmuppGui_8h_source.html#l00167">167</a> of file <a class="el" href="PmuppGui_8h_source.html">PmuppGui.h</a>.</p>
</div>
</div>
<a id="ab753f45e4c45e9f4ec5cc46c6fa85c53" name="ab753f45e4c45e9f4ec5cc46c6fa85c53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab753f45e4c45e9f4ec5cc46c6fa85c53">&#9670;&#160;</a></span>init()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void PmuppXY::init </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 private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the object to default state. </p>
<p>Initializes the <a class="el" href="classPmuppXY.html" title="Data structure for X-Y axis label associations.">PmuppXY</a> object to default state.</p>
<p>Sets the collection tag to -1 (invalid), clears the X-axis label, and empties the Y-axis label vector. This provides a clean starting state for the X-Y configuration. </p>
<p class="definition">Definition at line <a class="el" href="PmuppGui_8cpp_source.html#l00107">107</a> of file <a class="el" href="PmuppGui_8cpp_source.html">PmuppGui.cpp</a>.</p>
</div>
</div>
<a id="a971a6757b15b7c535148afedbc267697" name="a971a6757b15b7c535148afedbc267697"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a971a6757b15b7c535148afedbc267697">&#9670;&#160;</a></span>removeYlabel() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PmuppXY::removeYlabel </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>Removes a Y-axis label by index. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">idx</td><td>index of the Y-label to remove</td></tr>
</table>
</dd>
</dl>
<p>Deletes the Y-axis label at the specified position from the vector. If the index is out of bounds, the operation is silently ignored.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">idx</td><td>zero-based index of the Y-label to remove </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PmuppGui_8cpp_source.html#l00141">141</a> of file <a class="el" href="PmuppGui_8cpp_source.html">PmuppGui.cpp</a>.</p>
</div>
</div>
<a id="a3d4c456d7d0e320e112aaaadd7b78152" name="a3d4c456d7d0e320e112aaaadd7b78152"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d4c456d7d0e320e112aaaadd7b78152">&#9670;&#160;</a></span>removeYlabel() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PmuppXY::removeYlabel </td>
<td>(</td>
<td class="paramtype">QString</td> <td class="paramname"><span class="paramname"><em>str</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes a Y-axis label by name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>Y-axis parameter label to remove</td></tr>
</table>
</dd>
</dl>
<p>Searches for a Y-axis label matching the given string and removes it if found. Only the first matching label is removed. If no match is found, the vector remains unchanged.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>Y-axis parameter label string to remove </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PmuppGui_8cpp_source.html#l00159">159</a> of file <a class="el" href="PmuppGui_8cpp_source.html">PmuppGui.cpp</a>.</p>
</div>
</div>
<a id="a03a7a36c748d33e8f998148e94d5e777" name="a03a7a36c748d33e8f998148e94d5e777"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03a7a36c748d33e8f998148e94d5e777">&#9670;&#160;</a></span>setCollectionTag()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void PmuppXY::setCollectionTag </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>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the collection tag (identifier). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tag</td><td>collection identifier </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PmuppGui_8h_source.html#l00112">112</a> of file <a class="el" href="PmuppGui_8h_source.html">PmuppGui.h</a>.</p>
</div>
</div>
<a id="adab5e005819fd4429907792dcfd7e8ee" name="adab5e005819fd4429907792dcfd7e8ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adab5e005819fd4429907792dcfd7e8ee">&#9670;&#160;</a></span>setXlabel()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void PmuppXY::setXlabel </td>
<td>(</td>
<td class="paramtype">QString</td> <td class="paramname"><span class="paramname"><em>str</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>Sets the X-axis label. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>X-axis parameter label </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PmuppGui_8h_source.html#l00118">118</a> of file <a class="el" href="PmuppGui_8h_source.html">PmuppGui.h</a>.</p>
</div>
</div>
<a id="a70b55cc521b5bb2af9b826270c90b76f" name="a70b55cc521b5bb2af9b826270c90b76f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70b55cc521b5bb2af9b826270c90b76f">&#9670;&#160;</a></span>setYlabel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PmuppXY::setYlabel </td>
<td>(</td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>idx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QString</td> <td class="paramname"><span class="paramname"><em>str</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the Y-axis label at a specific index. </p>
<p>Sets a Y-axis label at a specific index.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">idx</td><td>index of the Y-label to modify </td></tr>
<tr><td class="paramname">str</td><td>new Y-axis parameter label</td></tr>
</table>
</dd>
</dl>
<p>Replaces the Y-axis label at the given index with a new value. If the index is out of bounds, the operation is silently ignored.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">idx</td><td>zero-based index of the Y-label to modify </td></tr>
<tr><td class="paramname">str</td><td>new Y-axis parameter label string </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PmuppGui_8cpp_source.html#l00124">124</a> of file <a class="el" href="PmuppGui_8cpp_source.html">PmuppGui.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="adfbfb2f66129db7b0a193d457a53a70b" name="adfbfb2f66129db7b0a193d457a53a70b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfbfb2f66129db7b0a193d457a53a70b">&#9670;&#160;</a></span>fCollectionTag</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int PmuppXY::fCollectionTag</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>identifier for the associated data collection </p>
<p class="definition">Definition at line <a class="el" href="PmuppGui_8h_source.html#l00190">190</a> of file <a class="el" href="PmuppGui_8h_source.html">PmuppGui.h</a>.</p>
</div>
</div>
<a id="a3fd2c85d0245d1d98dd5756147363886" name="a3fd2c85d0245d1d98dd5756147363886"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3fd2c85d0245d1d98dd5756147363886">&#9670;&#160;</a></span>fXlabel</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QString PmuppXY::fXlabel</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>X-axis parameter label. </p>
<p class="definition">Definition at line <a class="el" href="PmuppGui_8h_source.html#l00191">191</a> of file <a class="el" href="PmuppGui_8h_source.html">PmuppGui.h</a>.</p>
</div>
</div>
<a id="aef143d2d88116dbc3f6cca6c22b018cf" name="aef143d2d88116dbc3f6cca6c22b018cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef143d2d88116dbc3f6cca6c22b018cf">&#9670;&#160;</a></span>fYlabel</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QVector&lt;QString&gt; PmuppXY::fYlabel</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>vector of Y-axis parameter labels </p>
<p class="definition">Definition at line <a class="el" href="PmuppGui_8h_source.html#l00192">192</a> of file <a class="el" href="PmuppGui_8h_source.html">PmuppGui.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/workspace/LMU/musrfit/src/musredit_qt6/mupp/<a class="el" href="PmuppGui_8h_source.html">PmuppGui.h</a></li>
<li>/workspace/LMU/musrfit/src/musredit_qt6/mupp/<a class="el" href="PmuppGui_8cpp_source.html">PmuppGui.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2
</small></address>
</div><!-- doc-content -->
</body>
</html>