Gitea Actions
85 lines
3.6 KiB
TeX
85 lines
3.6 KiB
TeX
\doxysection{/workspace/\+LMU/musrfit/src/musredit\+\_\+qt6/musr\+Step/musr\+Step.cpp File Reference}
|
|
\hypertarget{musrStep_8cpp}{}\label{musrStep_8cpp}\index{/workspace/LMU/musrfit/src/musredit\_qt6/musrStep/musrStep.cpp@{/workspace/LMU/musrfit/src/musredit\_qt6/musrStep/musrStep.cpp}}
|
|
|
|
|
|
Main entry point for the musr\+Step application.
|
|
|
|
|
|
{\ttfamily \#include $<$iostream$>$}\newline
|
|
{\ttfamily \#include $<$cstring$>$}\newline
|
|
{\ttfamily \#include $<$QApplication$>$}\newline
|
|
{\ttfamily \#include $<$Qt\+Debug$>$}\newline
|
|
{\ttfamily \#include "{}PMusr\+Step.\+h"{}}\newline
|
|
\doxysubsubsection*{Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
void \mbox{\hyperlink{musrStep_8cpp_a240d5c7401fdcb5b7f5adf24a5a69c36}{musr\+Step\+\_\+syntax}} ()
|
|
\begin{DoxyCompactList}\small\item\em Prints the command-\/line syntax and usage information to stdout. \end{DoxyCompactList}\item
|
|
int \mbox{\hyperlink{musrStep_8cpp_a0ddf1224851353fc92bfbff6f499fa97}{main}} (int argc, char \texorpdfstring{$\ast$}{*}argv\mbox{[}$\,$\mbox{]})
|
|
\begin{DoxyCompactList}\small\item\em Main entry point for the musr\+Step application. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
Main entry point for the musr\+Step application.
|
|
|
|
musr\+Step is a Qt-\/based GUI application for adjusting fit parameter step sizes in mu\+SR msr-\/files. It provides an interactive interface to view, select, and modify the step values of fit parameters used by musrfit.
|
|
|
|
The application supports both automatic step size adjustment based on parameter naming conventions and manual scaling by user-\/defined factors.
|
|
|
|
\begin{DoxyAuthor}{Author}
|
|
Andreas Suter
|
|
\end{DoxyAuthor}
|
|
\begin{DoxyDate}{Date}
|
|
2007-\/2026
|
|
\end{DoxyDate}
|
|
\begin{DoxyCopyright}{Copyright}
|
|
GNU General Public License v2 or later
|
|
\end{DoxyCopyright}
|
|
|
|
|
|
\doxysubsection{Function Documentation}
|
|
\Hypertarget{musrStep_8cpp_a0ddf1224851353fc92bfbff6f499fa97}\index{musrStep.cpp@{musrStep.cpp}!main@{main}}
|
|
\index{main@{main}!musrStep.cpp@{musrStep.cpp}}
|
|
\doxysubsubsection{\texorpdfstring{main()}{main()}}
|
|
{\footnotesize\ttfamily \label{musrStep_8cpp_a0ddf1224851353fc92bfbff6f499fa97}
|
|
int main (\begin{DoxyParamCaption}\item[{int}]{argc}{, }\item[{char \texorpdfstring{$\ast$}{*}}]{argv}{\mbox{[}$\,$\mbox{]}}\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Main entry point for the musr\+Step application.
|
|
|
|
Parses command-\/line arguments and launches the musr\+Step GUI.
|
|
|
|
The application expects exactly one argument which can be\+:
|
|
\begin{DoxyItemize}
|
|
\item A path to an msr-\/file to open
|
|
\item -\/v or --version to display version information
|
|
\item -\/h or --help to display usage information
|
|
\end{DoxyItemize}
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em argc} & Number of command-\/line arguments \\
|
|
\hline
|
|
{\em argv} & Array of command-\/line argument strings \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\begin{DoxyReturn}{Returns}
|
|
0 on success, 1 on error or invalid usage
|
|
\end{DoxyReturn}
|
|
\Hypertarget{musrStep_8cpp_a240d5c7401fdcb5b7f5adf24a5a69c36}\index{musrStep.cpp@{musrStep.cpp}!musrStep\_syntax@{musrStep\_syntax}}
|
|
\index{musrStep\_syntax@{musrStep\_syntax}!musrStep.cpp@{musrStep.cpp}}
|
|
\doxysubsubsection{\texorpdfstring{musrStep\_syntax()}{musrStep\_syntax()}}
|
|
{\footnotesize\ttfamily \label{musrStep_8cpp_a240d5c7401fdcb5b7f5adf24a5a69c36}
|
|
void musr\+Step\+\_\+syntax (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Prints the command-\/line syntax and usage information to stdout.
|
|
|
|
This function displays the available command-\/line options\+:
|
|
\begin{DoxyItemize}
|
|
\item \texorpdfstring{$<$}{<}fln\texorpdfstring{$>$}{>}\+: The msr-\/file name to open and edit
|
|
\item -\/v, --version\+: Display git version information
|
|
\item -\/h, --help\+: Display this help message
|
|
\end{DoxyItemize} |