detectors/aare
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/aare.git synced 2025-06-13 07:47:13 +02:00
Code Issues Actions Packages Releases Activity

setup doxygen and clang-uml files

Browse Source
This commit is contained in:
Bechir Braham
2024-04-11 17:20:34 +02:00
parent 111b421476
commit 2ebbd0d7cd
640 changed files with 77235 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
docs/latex/classaare_1_1File_1_1File.tex Normal file
View File

@ -0,0 +1,67 @@
\doxysection{aare.\+File.\+File Class Reference}
\hypertarget{classaare_1_1File_1_1File}{}\label{classaare_1_1File_1_1File}\index{aare.File.File@{aare.File.File}}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{classaare_1_1File_1_1File_aa85e1dc7ac3997f3162212c449f70e0e}{\+\_\+\+\_\+init\+\_\+\+\_\+}} (self, \mbox{\hyperlink{classaare_1_1File_1_1File_a3f3a96562f0380956a9657544d577120}{path}})
\item
Any \mbox{\hyperlink{classaare_1_1File_1_1File_a9c61448799d43f31b8aa69cadb4ed810}{\+\_\+\+\_\+getattribute\+\_\+\+\_\+}} (self, str \+\_\+\+\_\+name)
\end{DoxyCompactItemize}
\doxysubsubsection*{Data Fields}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{classaare_1_1File_1_1File_a3f3a96562f0380956a9657544d577120}{path}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{classaare_1_1File_1_1File_ae419f2d8092730d05965c3492ea77806}{\+\_\+file}}
\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
\begin{DoxyVerb}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)
\end{DoxyVerb}
\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classaare_1_1File_1_1File_aa85e1dc7ac3997f3162212c449f70e0e}\label{classaare_1_1File_1_1File_aa85e1dc7ac3997f3162212c449f70e0e}
\index{aare.File.File@{aare.File.File}!\_\_init\_\_@{\_\_init\_\_}}
\index{\_\_init\_\_@{\_\_init\_\_}!aare.File.File@{aare.File.File}}
\doxysubsubsection{\texorpdfstring{\_\_init\_\_()}{\_\_init\_\_()}}
{\footnotesize\ttfamily aare.\+File.\+File.\+\_\+\+\_\+init\+\_\+\+\_\+ (\begin{DoxyParamCaption}\item[{}]{self, }\item[{}]{path }\end{DoxyParamCaption})}
\begin{DoxyVerb}opens the master file and checks the dynamic range and detector\end{DoxyVerb}
\doxysubsection{Member Function Documentation}
\Hypertarget{classaare_1_1File_1_1File_a9c61448799d43f31b8aa69cadb4ed810}\label{classaare_1_1File_1_1File_a9c61448799d43f31b8aa69cadb4ed810}
\index{aare.File.File@{aare.File.File}!\_\_getattribute\_\_@{\_\_getattribute\_\_}}
\index{\_\_getattribute\_\_@{\_\_getattribute\_\_}!aare.File.File@{aare.File.File}}
\doxysubsubsection{\texorpdfstring{\_\_getattribute\_\_()}{\_\_getattribute\_\_()}}
{\footnotesize\ttfamily Any aare.\+File.\+File.\+\_\+\+\_\+getattribute\+\_\+\+\_\+ (\begin{DoxyParamCaption}\item[{}]{self, }\item[{str}]{\+\_\+\+\_\+name }\end{DoxyParamCaption})}
\begin{DoxyVerb}Proxy pattern to call the methods of the _file
\end{DoxyVerb}
\doxysubsection{Field Documentation}
\Hypertarget{classaare_1_1File_1_1File_ae419f2d8092730d05965c3492ea77806}\label{classaare_1_1File_1_1File_ae419f2d8092730d05965c3492ea77806}
\index{aare.File.File@{aare.File.File}!\_file@{\_file}}
\index{\_file@{\_file}!aare.File.File@{aare.File.File}}
\doxysubsubsection{\texorpdfstring{\_file}{\_file}}
{\footnotesize\ttfamily aare.\+File.\+File.\+\_\+file\hspace{0.3cm}{\ttfamily [protected]}}
\Hypertarget{classaare_1_1File_1_1File_a3f3a96562f0380956a9657544d577120}\label{classaare_1_1File_1_1File_a3f3a96562f0380956a9657544d577120}
\index{aare.File.File@{aare.File.File}!path@{path}}
\index{path@{path}!aare.File.File@{aare.File.File}}
\doxysubsubsection{\texorpdfstring{path}{path}}
{\footnotesize\ttfamily aare.\+File.\+File.\+path}
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item
python/aare/\mbox{\hyperlink{File_8py}{File.\+py}}\end{DoxyCompactItemize}