detectors/aare
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/aare.git synced 2025-06-08 05:30:41 +02:00
Code Issues Actions Packages Releases Activity
aare/docs/html/classaare_1_1File_1_1File.html
Bechir Braham 2ebbd0d7cd
setup doxygen and clang-uml files
2024-04-11 17:20:34 +02:00

212 lines
9.1 KiB
HTML
Raw Permalink Blame History

<!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.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>AARE: aare.File.File 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>
<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">AARE
</div>
<div id="projectbrief">Data analysis library for PSI hybrid detectors</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<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" 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');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceaare.html">aare</a></li><li class="navelem"><a class="el" href="namespaceaare_1_1File.html">File</a></li><li class="navelem"><a class="el" href="classaare_1_1File_1_1File.html">File</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Data Fields</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle"><div class="title">aare.File.File Class Reference</div></div>
</div><!--header-->
<div class="contents">
<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:aa85e1dc7ac3997f3162212c449f70e0e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1File_1_1File.html#aa85e1dc7ac3997f3162212c449f70e0e">__init__</a> (self, <a class="el" href="classaare_1_1File_1_1File.html#a3f3a96562f0380956a9657544d577120">path</a>)</td></tr>
<tr class="separator:aa85e1dc7ac3997f3162212c449f70e0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c61448799d43f31b8aa69cadb4ed810"><td class="memItemLeft" align="right" valign="top">Any&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1File_1_1File.html#a9c61448799d43f31b8aa69cadb4ed810">__getattribute__</a> (self, str __name)</td></tr>
<tr class="separator:a9c61448799d43f31b8aa69cadb4ed810"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a3f3a96562f0380956a9657544d577120"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1File_1_1File.html#a3f3a96562f0380956a9657544d577120">path</a></td></tr>
<tr class="separator:a3f3a96562f0380956a9657544d577120"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ae419f2d8092730d05965c3492ea77806"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1File_1_1File.html#ae419f2d8092730d05965c3492ea77806">_file</a></td></tr>
<tr class="separator:ae419f2d8092730d05965c3492ea77806"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><pre class="fragment">File class. uses proxy pattern to wrap around the pybinding class
abstracts the python binding class that is requires type and detector information
(e.g. _FileHandler_Jungfrau_16)
</pre> </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa85e1dc7ac3997f3162212c449f70e0e" name="aa85e1dc7ac3997f3162212c449f70e0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa85e1dc7ac3997f3162212c449f70e0e">&#9670;&#160;</a></span>__init__()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">aare.File.File.__init__ </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>path</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">opens the master file and checks the dynamic range and detector</pre>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a9c61448799d43f31b8aa69cadb4ed810" name="a9c61448799d43f31b8aa69cadb4ed810"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c61448799d43f31b8aa69cadb4ed810">&#9670;&#160;</a></span>__getattribute__()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> Any aare.File.File.__getattribute__ </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">str&#160;</td>
<td class="paramname"><em>__name</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Proxy pattern to call the methods of the _file
</pre>
</div>
</div>
<h2 class="groupheader">Field Documentation</h2>
<a id="ae419f2d8092730d05965c3492ea77806" name="ae419f2d8092730d05965c3492ea77806"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae419f2d8092730d05965c3492ea77806">&#9670;&#160;</a></span>_file</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">aare.File.File._file</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3f3a96562f0380956a9657544d577120" name="a3f3a96562f0380956a9657544d577120"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f3a96562f0380956a9657544d577120">&#9670;&#160;</a></span>path</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">aare.File.File.path</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>python/aare/<a class="el" href="File_8py.html">File.py</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.9.7
</small></address>
</body>
</html>
View Git Blame Copy Permalink