Files
musrfit/doc/technical/html/musrWiz/latex/classPMusrWizDefaultXMLParser.tex
T
2026-07-31 18:47:29 +00:00

254 lines
17 KiB
TeX

\doxysection{PMusr\+Wiz\+Default\+XMLParser Class Reference}
\hypertarget{classPMusrWizDefaultXMLParser}{}\label{classPMusrWizDefaultXMLParser}\index{PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}}
The \doxylink{classPMusrWizDefaultXMLParser}{PMusr\+Wiz\+Default\+XMLParser} class parses the musr\+Wiz.\+xml default settings file.
{\ttfamily \#include $<$PAdmin.\+h$>$}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{classPMusrWizDefaultXMLParser_a0caa2df17335300ca9d0b00115b4317d}{PMusr\+Wiz\+Default\+XMLParser}} (const QString \&fln, \mbox{\hyperlink{classPAdmin}{PAdmin}} \texorpdfstring{$\ast$}{*})
\begin{DoxyCompactList}\small\item\em Constructor. Parses the given musr\+Wiz.\+xml file. \end{DoxyCompactList}\item
virtual \mbox{\hyperlink{classPMusrWizDefaultXMLParser_ab6f648c60475399c571d53871f1582f4}{\texorpdfstring{$\sim$}{\string~}\+PMusr\+Wiz\+Default\+XMLParser}} ()
\begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\item
virtual bool \mbox{\hyperlink{classPMusrWizDefaultXMLParser_a86b23e0028c922dbaaee35bd613475ea}{is\+Valid}} ()
\begin{DoxyCompactList}\small\item\em Checks if the XML parsing was successful. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Private Types}
\begin{DoxyCompactItemize}
\item
enum \mbox{\hyperlink{classPMusrWizDefaultXMLParser_a9590e2eb88191e80b66d563392c65eb0}{EKey\+Words}} \{ \mbox{\hyperlink{classPMusrWizDefaultXMLParser_a9590e2eb88191e80b66d563392c65eb0a740b2ef2c4298f1bb4ed804786c826aa}{e\+Empty}}
, \mbox{\hyperlink{classPMusrWizDefaultXMLParser_a9590e2eb88191e80b66d563392c65eb0ab2d640ca7c8d2bd93105d0fbb883e1d1}{e\+Institute}}
, \mbox{\hyperlink{classPMusrWizDefaultXMLParser_a9590e2eb88191e80b66d563392c65eb0a190bf39bcdf89cfda52d6c178fcc736a}{e\+Instrument}}
, \mbox{\hyperlink{classPMusrWizDefaultXMLParser_a9590e2eb88191e80b66d563392c65eb0a208cc548ca5e59195bcc4ec230a9fb8b}{e\+Fit\+Type}}
\}
\begin{DoxyCompactList}\small\item\em Enumeration of XML tag keywords for parsing state machine. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Private Member Functions}
\begin{DoxyCompactItemize}
\item
bool \mbox{\hyperlink{classPMusrWizDefaultXMLParser_af7cd62c95a551103add5bb9e0ecef64d}{parse}} (QIODevice \texorpdfstring{$\ast$}{*}device)
\item
bool \mbox{\hyperlink{classPMusrWizDefaultXMLParser_a523fc03389c55f6ebd26bba6915435ce}{start\+Document}} ()
\item
bool \mbox{\hyperlink{classPMusrWizDefaultXMLParser_a7d9a6a5f8de489ee495fdd2b71e94a61}{start\+Element}} ()
\item
bool \mbox{\hyperlink{classPMusrWizDefaultXMLParser_a6effb75e453cba3c96b682e8d3879afa}{end\+Element}} ()
\item
bool \mbox{\hyperlink{classPMusrWizDefaultXMLParser_a3ffe4bbb64fa069dba570f79c55a6765}{characters}} ()
\item
bool \mbox{\hyperlink{classPMusrWizDefaultXMLParser_ad9d8715083d3bba7a261c18cd1bb77f6}{end\+Document}} ()
\end{DoxyCompactItemize}
\doxysubsubsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item
QXml\+Stream\+Reader \mbox{\hyperlink{classPMusrWizDefaultXMLParser_a045019d236e8498ce187c5fafc28d4fe}{f\+Xml}}
\begin{DoxyCompactList}\small\item\em xml stream reader object \end{DoxyCompactList}\item
bool \mbox{\hyperlink{classPMusrWizDefaultXMLParser_a4cfaab8f18a89bf8882eaedb083ef0ab}{f\+Valid}}
\begin{DoxyCompactList}\small\item\em flag showing if XML read has been successful \end{DoxyCompactList}\item
\mbox{\hyperlink{classPMusrWizDefaultXMLParser_a9590e2eb88191e80b66d563392c65eb0}{EKey\+Words}} \mbox{\hyperlink{classPMusrWizDefaultXMLParser_a1c3f77f9ff1ad961b159b9b2e0ce08aa}{f\+Key\+Word}}
\begin{DoxyCompactList}\small\item\em key word tag to know how to handle the content \end{DoxyCompactList}\item
\mbox{\hyperlink{classPAdmin}{PAdmin}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{classPMusrWizDefaultXMLParser_a771ffd87d13ee49bd02839730e1406a0}{f\+Admin}}
\begin{DoxyCompactList}\small\item\em a pointer to the main administration class object \end{DoxyCompactList}\item
\mbox{\hyperlink{classPMusrWizDefault}{PMusr\+Wiz\+Default}} \mbox{\hyperlink{classPMusrWizDefaultXMLParser_aeba0dfe63249172d4aa691eb26966503}{f\+Default}}
\begin{DoxyCompactList}\small\item\em default settings being parsed \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
The \doxylink{classPMusrWizDefaultXMLParser}{PMusr\+Wiz\+Default\+XMLParser} class parses the musr\+Wiz.\+xml default settings file.
This class reads the musr\+Wiz.\+xml file which contains the default settings for the wizard, including the default institute, instrument, and fit type.
\doxysubsection{Member Enumeration Documentation}
\Hypertarget{classPMusrWizDefaultXMLParser_a9590e2eb88191e80b66d563392c65eb0}\index{PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}!EKeyWords@{EKeyWords}}
\index{EKeyWords@{EKeyWords}!PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}}
\doxysubsubsection{\texorpdfstring{EKeyWords}{EKeyWords}}
{\footnotesize\ttfamily \label{classPMusrWizDefaultXMLParser_a9590e2eb88191e80b66d563392c65eb0}
enum \mbox{\hyperlink{classPMusrWizDefaultXMLParser_a9590e2eb88191e80b66d563392c65eb0}{PMusr\+Wiz\+Default\+XMLParser\+::\+EKey\+Words}}\hspace{0.3cm}{\ttfamily [private]}}
Enumeration of XML tag keywords for parsing state machine.
\begin{DoxyEnumFields}[2]{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{eEmpty@{eEmpty}!PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}}\index{PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}!eEmpty@{eEmpty}}}\Hypertarget{classPMusrWizDefaultXMLParser_a9590e2eb88191e80b66d563392c65eb0a740b2ef2c4298f1bb4ed804786c826aa}\label{classPMusrWizDefaultXMLParser_a9590e2eb88191e80b66d563392c65eb0a740b2ef2c4298f1bb4ed804786c826aa}
e\+Empty&\\
\hline
\raisebox{\heightof{T}}[0pt][0pt]{\index{eInstitute@{eInstitute}!PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}}\index{PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}!eInstitute@{eInstitute}}}\Hypertarget{classPMusrWizDefaultXMLParser_a9590e2eb88191e80b66d563392c65eb0ab2d640ca7c8d2bd93105d0fbb883e1d1}\label{classPMusrWizDefaultXMLParser_a9590e2eb88191e80b66d563392c65eb0ab2d640ca7c8d2bd93105d0fbb883e1d1}
e\+Institute&\\
\hline
\raisebox{\heightof{T}}[0pt][0pt]{\index{eInstrument@{eInstrument}!PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}}\index{PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}!eInstrument@{eInstrument}}}\Hypertarget{classPMusrWizDefaultXMLParser_a9590e2eb88191e80b66d563392c65eb0a190bf39bcdf89cfda52d6c178fcc736a}\label{classPMusrWizDefaultXMLParser_a9590e2eb88191e80b66d563392c65eb0a190bf39bcdf89cfda52d6c178fcc736a}
e\+Instrument&\\
\hline
\raisebox{\heightof{T}}[0pt][0pt]{\index{eFitType@{eFitType}!PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}}\index{PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}!eFitType@{eFitType}}}\Hypertarget{classPMusrWizDefaultXMLParser_a9590e2eb88191e80b66d563392c65eb0a208cc548ca5e59195bcc4ec230a9fb8b}\label{classPMusrWizDefaultXMLParser_a9590e2eb88191e80b66d563392c65eb0a208cc548ca5e59195bcc4ec230a9fb8b}
e\+Fit\+Type&\\
\hline
\end{DoxyEnumFields}
\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classPMusrWizDefaultXMLParser_a0caa2df17335300ca9d0b00115b4317d}\index{PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}!PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}}
\index{PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}!PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}}
\doxysubsubsection{\texorpdfstring{PMusrWizDefaultXMLParser()}{PMusrWizDefaultXMLParser()}}
{\footnotesize\ttfamily \label{classPMusrWizDefaultXMLParser_a0caa2df17335300ca9d0b00115b4317d}
PMusr\+Wiz\+Default\+XMLParser\+::\+PMusr\+Wiz\+Default\+XMLParser (\begin{DoxyParamCaption}\item[{const QString \&}]{fln}{, }\item[{\mbox{\hyperlink{classPAdmin}{PAdmin}} \texorpdfstring{$\ast$}{*}}]{admin}{}\end{DoxyParamCaption})}
Constructor. Parses the given musr\+Wiz.\+xml file.
\begin{DoxyParams}{Parameters}
{\em fln} & Path to the musr\+Wiz.\+xml file. \\
\hline
{\em admin} & Pointer to the \doxylink{classPAdmin}{PAdmin} object where parsed defaults will be stored.\\
\hline
\end{DoxyParams}
XML Parser class for the musr\+Wiz default settings.
\begin{DoxyParams}{Parameters}
{\em admin} & pointer to an admin class instance. \\
\hline
\end{DoxyParams}
\Hypertarget{classPMusrWizDefaultXMLParser_ab6f648c60475399c571d53871f1582f4}\index{PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}!````~PMusrWizDefaultXMLParser@{\texorpdfstring{$\sim$}{\string~}PMusrWizDefaultXMLParser}}
\index{````~PMusrWizDefaultXMLParser@{\texorpdfstring{$\sim$}{\string~}PMusrWizDefaultXMLParser}!PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}}
\doxysubsubsection{\texorpdfstring{\texorpdfstring{$\sim$}{\string~}PMusrWizDefaultXMLParser()}{\string~PMusrWizDefaultXMLParser()}}
{\footnotesize\ttfamily \label{classPMusrWizDefaultXMLParser_ab6f648c60475399c571d53871f1582f4}
virtual PMusr\+Wiz\+Default\+XMLParser\+::\texorpdfstring{$\sim$}{\string~}\+PMusr\+Wiz\+Default\+XMLParser (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
Destructor.
\doxysubsection{Member Function Documentation}
\Hypertarget{classPMusrWizDefaultXMLParser_a3ffe4bbb64fa069dba570f79c55a6765}\index{PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}!characters@{characters}}
\index{characters@{characters}!PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}}
\doxysubsubsection{\texorpdfstring{characters()}{characters()}}
{\footnotesize\ttfamily \label{classPMusrWizDefaultXMLParser_a3ffe4bbb64fa069dba570f79c55a6765}
bool PMusr\+Wiz\+Default\+XMLParser\+::characters (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
This routine delivers the content of an XML tag. It fills the content into the load data structure. \Hypertarget{classPMusrWizDefaultXMLParser_ad9d8715083d3bba7a261c18cd1bb77f6}\index{PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}!endDocument@{endDocument}}
\index{endDocument@{endDocument}!PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}}
\doxysubsubsection{\texorpdfstring{endDocument()}{endDocument()}}
{\footnotesize\ttfamily \label{classPMusrWizDefaultXMLParser_ad9d8715083d3bba7a261c18cd1bb77f6}
bool PMusr\+Wiz\+Default\+XMLParser\+::end\+Document (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
Called at the end of the XML parse process. \Hypertarget{classPMusrWizDefaultXMLParser_a6effb75e453cba3c96b682e8d3879afa}\index{PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}!endElement@{endElement}}
\index{endElement@{endElement}!PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}}
\doxysubsubsection{\texorpdfstring{endElement()}{endElement()}}
{\footnotesize\ttfamily \label{classPMusrWizDefaultXMLParser_a6effb75e453cba3c96b682e8d3879afa}
bool PMusr\+Wiz\+Default\+XMLParser\+::end\+Element (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
Routine called when the end XML tag is found. It is used to put the filtering tag to \textquotesingle{}empty\textquotesingle{}. It also resets the f\+Func flag in case the entry was a theory function. \Hypertarget{classPMusrWizDefaultXMLParser_a86b23e0028c922dbaaee35bd613475ea}\index{PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}!isValid@{isValid}}
\index{isValid@{isValid}!PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}}
\doxysubsubsection{\texorpdfstring{isValid()}{isValid()}}
{\footnotesize\ttfamily \label{classPMusrWizDefaultXMLParser_a86b23e0028c922dbaaee35bd613475ea}
virtual bool PMusr\+Wiz\+Default\+XMLParser\+::is\+Valid (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
Checks if the XML parsing was successful.
\begin{DoxyReturn}{Returns}
true if parsing succeeded, false otherwise.
\end{DoxyReturn}
\Hypertarget{classPMusrWizDefaultXMLParser_af7cd62c95a551103add5bb9e0ecef64d}\index{PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}!parse@{parse}}
\index{parse@{parse}!PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}}
\doxysubsubsection{\texorpdfstring{parse()}{parse()}}
{\footnotesize\ttfamily \label{classPMusrWizDefaultXMLParser_af7cd62c95a551103add5bb9e0ecef64d}
bool PMusr\+Wiz\+Default\+XMLParser\+::parse (\begin{DoxyParamCaption}\item[{QIODevice \texorpdfstring{$\ast$}{*}}]{device}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
parse the musr\+Wiz startup xml-\/file.
\begin{DoxyParams}{Parameters}
{\em device} & QFile object of the musr\+Wiz startup xml-\/file\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true on success, false otherwise
\end{DoxyReturn}
\Hypertarget{classPMusrWizDefaultXMLParser_a523fc03389c55f6ebd26bba6915435ce}\index{PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}!startDocument@{startDocument}}
\index{startDocument@{startDocument}!PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}}
\doxysubsubsection{\texorpdfstring{startDocument()}{startDocument()}}
{\footnotesize\ttfamily \label{classPMusrWizDefaultXMLParser_a523fc03389c55f6ebd26bba6915435ce}
bool PMusr\+Wiz\+Default\+XMLParser\+::start\+Document (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
Routine called at the beginning of the XML parsing process. \Hypertarget{classPMusrWizDefaultXMLParser_a7d9a6a5f8de489ee495fdd2b71e94a61}\index{PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}!startElement@{startElement}}
\index{startElement@{startElement}!PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}}
\doxysubsubsection{\texorpdfstring{startElement()}{startElement()}}
{\footnotesize\ttfamily \label{classPMusrWizDefaultXMLParser_a7d9a6a5f8de489ee495fdd2b71e94a61}
bool PMusr\+Wiz\+Default\+XMLParser\+::start\+Element (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [private]}}
Routine called when a new XML tag is found. Here it is used to set a tag for filtering afterwards the content.
\doxysubsection{Member Data Documentation}
\Hypertarget{classPMusrWizDefaultXMLParser_a771ffd87d13ee49bd02839730e1406a0}\index{PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}!fAdmin@{fAdmin}}
\index{fAdmin@{fAdmin}!PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}}
\doxysubsubsection{\texorpdfstring{fAdmin}{fAdmin}}
{\footnotesize\ttfamily \label{classPMusrWizDefaultXMLParser_a771ffd87d13ee49bd02839730e1406a0}
\mbox{\hyperlink{classPAdmin}{PAdmin}}\texorpdfstring{$\ast$}{*} PMusr\+Wiz\+Default\+XMLParser\+::f\+Admin\hspace{0.3cm}{\ttfamily [private]}}
a pointer to the main administration class object
\Hypertarget{classPMusrWizDefaultXMLParser_aeba0dfe63249172d4aa691eb26966503}\index{PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}!fDefault@{fDefault}}
\index{fDefault@{fDefault}!PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}}
\doxysubsubsection{\texorpdfstring{fDefault}{fDefault}}
{\footnotesize\ttfamily \label{classPMusrWizDefaultXMLParser_aeba0dfe63249172d4aa691eb26966503}
\mbox{\hyperlink{classPMusrWizDefault}{PMusr\+Wiz\+Default}} PMusr\+Wiz\+Default\+XMLParser\+::f\+Default\hspace{0.3cm}{\ttfamily [private]}}
default settings being parsed
\Hypertarget{classPMusrWizDefaultXMLParser_a1c3f77f9ff1ad961b159b9b2e0ce08aa}\index{PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}!fKeyWord@{fKeyWord}}
\index{fKeyWord@{fKeyWord}!PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}}
\doxysubsubsection{\texorpdfstring{fKeyWord}{fKeyWord}}
{\footnotesize\ttfamily \label{classPMusrWizDefaultXMLParser_a1c3f77f9ff1ad961b159b9b2e0ce08aa}
\mbox{\hyperlink{classPMusrWizDefaultXMLParser_a9590e2eb88191e80b66d563392c65eb0}{EKey\+Words}} PMusr\+Wiz\+Default\+XMLParser\+::f\+Key\+Word\hspace{0.3cm}{\ttfamily [private]}}
key word tag to know how to handle the content
\Hypertarget{classPMusrWizDefaultXMLParser_a4cfaab8f18a89bf8882eaedb083ef0ab}\index{PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}!fValid@{fValid}}
\index{fValid@{fValid}!PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}}
\doxysubsubsection{\texorpdfstring{fValid}{fValid}}
{\footnotesize\ttfamily \label{classPMusrWizDefaultXMLParser_a4cfaab8f18a89bf8882eaedb083ef0ab}
bool PMusr\+Wiz\+Default\+XMLParser\+::f\+Valid\hspace{0.3cm}{\ttfamily [private]}}
flag showing if XML read has been successful
\Hypertarget{classPMusrWizDefaultXMLParser_a045019d236e8498ce187c5fafc28d4fe}\index{PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}!fXml@{fXml}}
\index{fXml@{fXml}!PMusrWizDefaultXMLParser@{PMusrWizDefaultXMLParser}}
\doxysubsubsection{\texorpdfstring{fXml}{fXml}}
{\footnotesize\ttfamily \label{classPMusrWizDefaultXMLParser_a045019d236e8498ce187c5fafc28d4fe}
QXml\+Stream\+Reader PMusr\+Wiz\+Default\+XMLParser\+::f\+Xml\hspace{0.3cm}{\ttfamily [private]}}
xml stream reader object
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
/workspace/\+LMU/musrfit/src/musredit\+\_\+qt6/musr\+Wiz/\mbox{\hyperlink{PAdmin_8h}{PAdmin.\+h}}\item
/workspace/\+LMU/musrfit/src/musredit\+\_\+qt6/musr\+Wiz/\mbox{\hyperlink{PAdmin_8cpp}{PAdmin.\+cpp}}\end{DoxyCompactItemize}