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

167 lines
22 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>musrfit: /workspace/LMU/musrfit/src/include/PFindRun.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">musrfit<span id="projectnumber">&#160;1.9.9</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','Search',true);
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('PFindRun_8h_source.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle"><div class="title">PFindRun.h</div></div>
</div><!--header-->
<div class="contents">
<a href="PFindRun_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/***************************************************************************</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"></span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> PFindRun.h</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"></span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> Author: Andreas Suter</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> e-mail: andreas.suter@psi.ch</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"></span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">***************************************************************************/</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">/***************************************************************************</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * Copyright (C) 2007-2025 by Andreas Suter *</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * andreas.suter@psi.ch *</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * *</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * This program is free software; you can redistribute it and/or modify *</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * it under the terms of the GNU General Public License as published by *</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * the Free Software Foundation; either version 2 of the License, or *</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * (at your option) any later version. *</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> * *</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"> * This program is distributed in the hope that it will be useful, *</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of *</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"> * GNU General Public License for more details. *</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment"> * *</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment"> * You should have received a copy of the GNU General Public License *</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"> * along with this program; if not, write to the *</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment"> * Free Software Foundation, Inc., *</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment"> * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment"> ***************************************************************************/</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#ifndef _PFINDRUN_H_</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#define _PFINDRUN_H_</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#include &quot;<a class="code" href="PMusr_8h.html">PMusr.h</a>&quot;</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment">//--------------------------------------------------------------------------</span></div>
<div class="foldopen" id="foldopen00068" data-start="{" data-end="};">
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="classPFindRun.html"> 68</a></span><span class="keyword">class </span><a class="code hl_function" href="classPFindRun.html#af79fc78d3dc2ca2d18a1023007d5c06d">PFindRun</a> {</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="comment">//----------------------------------------------------------------------</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <a class="code hl_function" href="classPFindRun.html#af79fc78d3dc2ca2d18a1023007d5c06d">PFindRun</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="PMusr_8h.html#ae50e503cc0f1bbc1fda5b86735ea9983">PStringVector</a> path, <span class="keyword">const</span> <a class="code hl_typedef" href="PMusr_8h.html#a01ff11ebda5d1a9096e8c9a65d085778">PRunNameTemplateList</a> runNameTemplateList);</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="comment">//----------------------------------------------------------------------</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <a class="code hl_function" href="classPFindRun.html#af79fc78d3dc2ca2d18a1023007d5c06d">PFindRun</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="PMusr_8h.html#ae50e503cc0f1bbc1fda5b86735ea9983">PStringVector</a> path, <span class="keyword">const</span> <a class="code hl_typedef" href="PMusr_8h.html#a01ff11ebda5d1a9096e8c9a65d085778">PRunNameTemplateList</a> runNameTemplateList,</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">const</span> TString &amp;instrument, <span class="keyword">const</span> UInt_t year, <span class="keyword">const</span> UInt_t run, <span class="keyword">const</span> TString file_format=<span class="stringliteral">&quot;&quot;</span>);</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <span class="comment">//----------------------------------------------------------------------</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> Bool_t <a class="code hl_function" href="classPFindRun.html#ac80cae699db88f45a24fd087b77d9a39">FoundPathName</a>();</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> </div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> <span class="comment">//----------------------------------------------------------------------</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"><a class="line" href="classPFindRun.html#aef0d2bbab3475c7599ba624d9005d73b"> 128</a></span> TString <a class="code hl_function" href="classPFindRun.html#aef0d2bbab3475c7599ba624d9005d73b">GetPathName</a>() { <span class="keywordflow">return</span> <a class="code hl_variable" href="classPFindRun.html#a1217b7ae5766231c388a2a522882ffd5">fPathName</a>; }</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> </div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> <span class="comment">//----------------------------------------------------------------------</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classPFindRun.html#a6522eccd3a89008f05b80e9b7a343999">DumpTemplateList</a>();</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> </div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"><a class="line" href="classPFindRun.html#a7c834ebdce8739bd2f7437bf1ce167d4"> 140</a></span> <span class="keyword">const</span> <a class="code hl_typedef" href="PMusr_8h.html#ae50e503cc0f1bbc1fda5b86735ea9983">PStringVector</a> <a class="code hl_variable" href="classPFindRun.html#a7c834ebdce8739bd2f7437bf1ce167d4">fPath</a>; </div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"><a class="line" href="classPFindRun.html#ae2d288d577eaf97a4d5cce10cfc0afb8"> 141</a></span> <span class="keyword">const</span> <a class="code hl_typedef" href="PMusr_8h.html#a01ff11ebda5d1a9096e8c9a65d085778">PRunNameTemplateList</a> <a class="code hl_variable" href="classPFindRun.html#ae2d288d577eaf97a4d5cce10cfc0afb8">fRunNameTemplateList</a>; </div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"><a class="line" href="classPFindRun.html#a1d3e9ae32d28d4df255e770f01e98fb4"> 142</a></span> TString <a class="code hl_variable" href="classPFindRun.html#a1d3e9ae32d28d4df255e770f01e98fb4">fInstrument</a>{<span class="stringliteral">&quot;&quot;</span>}; </div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"><a class="line" href="classPFindRun.html#a0bf08210c9dcc095c936e231e44c0a9b"> 143</a></span> Int_t <a class="code hl_variable" href="classPFindRun.html#a0bf08210c9dcc095c936e231e44c0a9b">fYear</a>{-1}; </div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"><a class="line" href="classPFindRun.html#aa3c0970f0b6d9d3ffd5034c507d72061"> 144</a></span> Int_t <a class="code hl_variable" href="classPFindRun.html#aa3c0970f0b6d9d3ffd5034c507d72061">fRun</a>{-1}; </div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"><a class="line" href="classPFindRun.html#ab3cc44abd696e2be144bbd4bfe309fd0"> 145</a></span> TString <a class="code hl_variable" href="classPFindRun.html#ab3cc44abd696e2be144bbd4bfe309fd0">fFileFormat</a>{<span class="stringliteral">&quot;&quot;</span>}; </div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"><a class="line" href="classPFindRun.html#a1217b7ae5766231c388a2a522882ffd5"> 146</a></span> TString <a class="code hl_variable" href="classPFindRun.html#a1217b7ae5766231c388a2a522882ffd5">fPathName</a>{<span class="stringliteral">&quot;&quot;</span>}; </div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> </div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> <span class="comment">//----------------------------------------------------------------------</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span> TString <a class="code hl_function" href="classPFindRun.html#af191829d46f7ecf9076855aa8dd78bb0">CreatePathName</a>(<span class="keyword">const</span> TString path, <span class="keyword">const</span> TString runNameTemplate);</div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span>};</div>
</div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> </div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span><span class="preprocessor">#endif </span><span class="comment">// _PFINDRUN_H_</span></div>
<div class="ttc" id="aPMusr_8h_html"><div class="ttname"><a href="PMusr_8h.html">PMusr.h</a></div></div>
<div class="ttc" id="aPMusr_8h_html_a01ff11ebda5d1a9096e8c9a65d085778"><div class="ttname"><a href="PMusr_8h.html#a01ff11ebda5d1a9096e8c9a65d085778">PRunNameTemplateList</a></div><div class="ttdeci">std::vector&lt; PRunNameTemplate &gt; PRunNameTemplateList</div><div class="ttdef"><b>Definition</b> <a href="PMusr_8h_source.html#l01441">PMusr.h:1441</a></div></div>
<div class="ttc" id="aPMusr_8h_html_ae50e503cc0f1bbc1fda5b86735ea9983"><div class="ttname"><a href="PMusr_8h.html#ae50e503cc0f1bbc1fda5b86735ea9983">PStringVector</a></div><div class="ttdeci">std::vector&lt; TString &gt; PStringVector</div><div class="ttdef"><b>Definition</b> <a href="PMusr_8h_source.html#l00403">PMusr.h:403</a></div></div>
<div class="ttc" id="aclassPFindRun_html_a0bf08210c9dcc095c936e231e44c0a9b"><div class="ttname"><a href="classPFindRun.html#a0bf08210c9dcc095c936e231e44c0a9b">PFindRun::fYear</a></div><div class="ttdeci">Int_t fYear</div><div class="ttdoc">Run year (-1 if not specified)</div><div class="ttdef"><b>Definition</b> <a href="#l00143">PFindRun.h:143</a></div></div>
<div class="ttc" id="aclassPFindRun_html_a1217b7ae5766231c388a2a522882ffd5"><div class="ttname"><a href="classPFindRun.html#a1217b7ae5766231c388a2a522882ffd5">PFindRun::fPathName</a></div><div class="ttdeci">TString fPathName</div><div class="ttdoc">Resolved full path (empty until found)</div><div class="ttdef"><b>Definition</b> <a href="#l00146">PFindRun.h:146</a></div></div>
<div class="ttc" id="aclassPFindRun_html_a1d3e9ae32d28d4df255e770f01e98fb4"><div class="ttname"><a href="classPFindRun.html#a1d3e9ae32d28d4df255e770f01e98fb4">PFindRun::fInstrument</a></div><div class="ttdeci">TString fInstrument</div><div class="ttdoc">Target instrument name (e.g., &quot;GPS&quot;, &quot;LEM&quot;)</div><div class="ttdef"><b>Definition</b> <a href="#l00142">PFindRun.h:142</a></div></div>
<div class="ttc" id="aclassPFindRun_html_a6522eccd3a89008f05b80e9b7a343999"><div class="ttname"><a href="classPFindRun.html#a6522eccd3a89008f05b80e9b7a343999">PFindRun::DumpTemplateList</a></div><div class="ttdeci">void DumpTemplateList()</div><div class="ttdoc">Debug utility - Prints current search configuration to stdout.</div><div class="ttdef"><b>Definition</b> <a href="PFindRun_8cpp_source.html#l00069">PFindRun.cpp:69</a></div></div>
<div class="ttc" id="aclassPFindRun_html_a7c834ebdce8739bd2f7437bf1ce167d4"><div class="ttname"><a href="classPFindRun.html#a7c834ebdce8739bd2f7437bf1ce167d4">PFindRun::fPath</a></div><div class="ttdeci">const PStringVector fPath</div><div class="ttdoc">Search paths for data files.</div><div class="ttdef"><b>Definition</b> <a href="#l00140">PFindRun.h:140</a></div></div>
<div class="ttc" id="aclassPFindRun_html_aa3c0970f0b6d9d3ffd5034c507d72061"><div class="ttname"><a href="classPFindRun.html#aa3c0970f0b6d9d3ffd5034c507d72061">PFindRun::fRun</a></div><div class="ttdeci">Int_t fRun</div><div class="ttdoc">Run number (-1 if not specified)</div><div class="ttdef"><b>Definition</b> <a href="#l00144">PFindRun.h:144</a></div></div>
<div class="ttc" id="aclassPFindRun_html_ab3cc44abd696e2be144bbd4bfe309fd0"><div class="ttname"><a href="classPFindRun.html#ab3cc44abd696e2be144bbd4bfe309fd0">PFindRun::fFileFormat</a></div><div class="ttdeci">TString fFileFormat</div><div class="ttdoc">Optional file format filter (empty = any)</div><div class="ttdef"><b>Definition</b> <a href="#l00145">PFindRun.h:145</a></div></div>
<div class="ttc" id="aclassPFindRun_html_ac80cae699db88f45a24fd087b77d9a39"><div class="ttname"><a href="classPFindRun.html#ac80cae699db88f45a24fd087b77d9a39">PFindRun::FoundPathName</a></div><div class="ttdeci">Bool_t FoundPathName()</div><div class="ttdoc">Searches for the run file using configured templates and paths.</div><div class="ttdef"><b>Definition</b> <a href="PFindRun_8cpp_source.html#l00133">PFindRun.cpp:133</a></div></div>
<div class="ttc" id="aclassPFindRun_html_ae2d288d577eaf97a4d5cce10cfc0afb8"><div class="ttname"><a href="classPFindRun.html#ae2d288d577eaf97a4d5cce10cfc0afb8">PFindRun::fRunNameTemplateList</a></div><div class="ttdeci">const PRunNameTemplateList fRunNameTemplateList</div><div class="ttdoc">Template patterns per instrument.</div><div class="ttdef"><b>Definition</b> <a href="#l00141">PFindRun.h:141</a></div></div>
<div class="ttc" id="aclassPFindRun_html_aef0d2bbab3475c7599ba624d9005d73b"><div class="ttname"><a href="classPFindRun.html#aef0d2bbab3475c7599ba624d9005d73b">PFindRun::GetPathName</a></div><div class="ttdeci">TString GetPathName()</div><div class="ttdoc">Returns the full path to the found run file.</div><div class="ttdef"><b>Definition</b> <a href="#l00128">PFindRun.h:128</a></div></div>
<div class="ttc" id="aclassPFindRun_html_af191829d46f7ecf9076855aa8dd78bb0"><div class="ttname"><a href="classPFindRun.html#af191829d46f7ecf9076855aa8dd78bb0">PFindRun::CreatePathName</a></div><div class="ttdeci">TString CreatePathName(const TString path, const TString runNameTemplate)</div><div class="ttdoc">Generates full file path by substituting template placeholders.</div><div class="ttdef"><b>Definition</b> <a href="PFindRun_8cpp_source.html#l00089">PFindRun.cpp:89</a></div></div>
<div class="ttc" id="aclassPFindRun_html_af79fc78d3dc2ca2d18a1023007d5c06d"><div class="ttname"><a href="classPFindRun.html#af79fc78d3dc2ca2d18a1023007d5c06d">PFindRun::PFindRun</a></div><div class="ttdeci">PFindRun(const PStringVector path, const PRunNameTemplateList runNameTemplateList)</div><div class="ttdoc">Default constructor - Creates instance without search parameters.</div><div class="ttdef"><b>Definition</b> <a href="PFindRun_8cpp_source.html#l00040">PFindRun.cpp:40</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b0856f6b0d80ccb263b2f415c91f9e17.html">include</a></li><li class="navelem"><a class="el" href="PFindRun_8h.html">PFindRun.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
</ul>
</div>
</body>
</html>