From bb917b70f3ee466d71419ff53f08a793b09fbf81 Mon Sep 17 00:00:00 2001 From: Dhanya Maliakal Date: Tue, 15 Aug 2017 18:42:41 +0200 Subject: [PATCH] more changes to client docu. more coming up --- .../slsDetector/slsDetectorCommand.cpp | 55 ++++++++++- .../slsDetectorClientDocs/html/config.html | 56 ++++++++++- .../slsDetectorClientDocs/latex/config.tex | 92 ++++++++++++++++++- .../slsDetectorClientDocs/latex/doxygen.sty | 4 +- .../slsDetectorClientDocs/latex/refman.tex | 2 +- 5 files changed, 203 insertions(+), 6 deletions(-) diff --git a/slsDetectorSoftware/slsDetector/slsDetectorCommand.cpp b/slsDetectorSoftware/slsDetector/slsDetectorCommand.cpp index e66294451..9d4e1820c 100644 --- a/slsDetectorSoftware/slsDetector/slsDetectorCommand.cpp +++ b/slsDetectorSoftware/slsDetector/slsDetectorCommand.cpp @@ -1380,77 +1380,130 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) { /* r/w timers */ + /*! \page config + - timing [mode] sets/gets synchronization mode of the detector. Mode: auto, trigger, ro_trigger, gating, triggered_gating + */ descrToFuncMap[i].m_pFuncName="timing"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTiming; i++; + /*! \page config + - exptime [i] sets/gets exposure time in s + */ descrToFuncMap[i].m_pFuncName="exptime"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimer; i++; + /*! \page config + - subexptime [i] sets/gets sub exposure time in s. Used in EIGER only in 32 bit mode. + */ descrToFuncMap[i].m_pFuncName="subexptime"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimer; i++; + /*! \page config + - period [i] sets/gets frame period in s. + */ descrToFuncMap[i].m_pFuncName="period"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimer; i++; + /*! \page config + - delay [i] sets/gets delay in s. Used in MYTHEN, GOTTHARD only + */ descrToFuncMap[i].m_pFuncName="delay"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimer; i++; + /*! \page config + - gates [i] sets/gets number of gates. Used in MYTHEN, GOTTHARD, EIGER only + */ descrToFuncMap[i].m_pFuncName="gates"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimer; i++; + /*! \page config + - gates [i] sets/gets number of frames. If \c timing is not \c auto, then it is the number of frames per cycle/trigger. + */ descrToFuncMap[i].m_pFuncName="frames"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimer; i++; + /*! \page config + - cycles [i] sets/gets number of triggers. Timing mode should be set appropriately. + */ descrToFuncMap[i].m_pFuncName="cycles"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimer; i++; + /*! \page config + - probes [i] sets/gets number of probes to accumulate. When setting, max 3! cycles should be set to 1, frames to the number of pump-probe events. Used in MYTHEN only + */ descrToFuncMap[i].m_pFuncName="probes"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimer; i++; - + /*! \page config + - measurements [i] sets/gets number of measurements. + */ descrToFuncMap[i].m_pFuncName="measurements"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimer; i++; + /*! \page config + - samples [i] sets/gets number of samples expected from the jctb. Used in CHIP TEST BOARD only. + */ descrToFuncMap[i].m_pFuncName="samples"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimer; i++; /* read only timers */ + /*! \page config + - exptimel [i] gets exposure time left. Used in MYTHEN, GOTTHARD only. + */ descrToFuncMap[i].m_pFuncName="exptimel"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimeLeft; i++; + /*! \page config + - periodl [i] gets frame period left. Used in MYTHEN, GOTTHARD only. + */ descrToFuncMap[i].m_pFuncName="periodl"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimeLeft; i++; + /*! \page config + - delayl [i] gets delay left. Used in MYTHEN, GOTTHARD only. + */ descrToFuncMap[i].m_pFuncName="delayl"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimeLeft; i++; + /*! \page config + - gatesl [i] gets number of gates left. Used in MYTHEN, GOTTHARD only. + */ descrToFuncMap[i].m_pFuncName="gatesl"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimeLeft; i++; + /*! \page config + - framesl [i] gets number of frames left. Used in MYTHEN, GOTTHARD only. + */ descrToFuncMap[i].m_pFuncName="framesl"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimeLeft; i++; + /*! \page config + - cyclesl [i] gets number of cylces left. Used in MYTHEN, GOTTHARD only. + */ descrToFuncMap[i].m_pFuncName="cyclesl"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimeLeft; i++; + /*! \page config + - probesl [i] gets number of probes left. Used in MYTHEN, GOTTHARD only. + */ descrToFuncMap[i].m_pFuncName="probesl"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimeLeft; i++; diff --git a/slsDetectorSoftware/slsDetectorClientDocs/html/config.html b/slsDetectorSoftware/slsDetectorClientDocs/html/config.html index 69e6f447c..f56fa32ce 100644 --- a/slsDetectorSoftware/slsDetectorClientDocs/html/config.html +++ b/slsDetectorSoftware/slsDetectorClientDocs/html/config.html @@ -137,7 +137,61 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • thisversion Gets the software version of this client software. Only get!
    • + + + + + + + + + + + + + + + + + + diff --git a/slsDetectorSoftware/slsDetectorClientDocs/latex/config.tex b/slsDetectorSoftware/slsDetectorClientDocs/latex/config.tex index 777ccab11..4fae3e75f 100644 --- a/slsDetectorSoftware/slsDetectorClientDocs/latex/config.tex +++ b/slsDetectorSoftware/slsDetectorClientDocs/latex/config.tex @@ -163,5 +163,95 @@ Commands to configure the detector. these commands are often left to the configu \begin{DoxyItemize} -\item {\bfseries receiverversion} Gets the software version of receiver. Only get! +\item {\bfseries receiverversion} Gets the software version of receiver. Only get! +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries timing \mbox{[}mode\mbox{]}} sets/gets synchronization mode of the detector. Mode: auto, trigger, ro\_\-trigger, gating, triggered\_\-gating +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries exptime \mbox{[}i\mbox{]}} sets/gets exposure time in s +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries subexptime \mbox{[}i\mbox{]}} sets/gets sub exposure time in s. Used in EIGER only in 32 bit mode. +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries period \mbox{[}i\mbox{]}} sets/gets frame period in s. +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries delay \mbox{[}i\mbox{]}} sets/gets delay in s. Used in MYTHEN, GOTTHARD only +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries gates \mbox{[}i\mbox{]}} sets/gets number of gates. Used in MYTHEN, GOTTHARD, EIGER only +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries gates \mbox{[}i\mbox{]}} sets/gets number of frames. If {\ttfamily timing} is not {\ttfamily auto}, then it is the number of frames per cycle/trigger. +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries cycles \mbox{[}i\mbox{]}} sets/gets number of triggers. Timing mode should be set appropriately. +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries probes \mbox{[}i\mbox{]}} sets/gets number of probes to accumulate. When setting, max 3! cycles should be set to 1, frames to the number of pump-\/probe events. Used in MYTHEN only +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries measurements \mbox{[}i\mbox{]}} sets/gets number of measurements. +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries samples \mbox{[}i\mbox{]}} sets/gets number of samples expected from the jctb. Used in CHIP TEST BOARD only. +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries exptimel \mbox{[}i\mbox{]}} gets exposure time left. Used in MYTHEN, GOTTHARD only. +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries periodl \mbox{[}i\mbox{]}} gets frame period left. Used in MYTHEN, GOTTHARD only. +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries delayl \mbox{[}i\mbox{]}} gets delay left. Used in MYTHEN, GOTTHARD only. +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries gatesl \mbox{[}i\mbox{]}} gets number of gates left. Used in MYTHEN, GOTTHARD only. +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries framesl \mbox{[}i\mbox{]}} gets number of frames left. Used in MYTHEN, GOTTHARD only. +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries cyclesl \mbox{[}i\mbox{]}} gets number of cylces left. Used in MYTHEN, GOTTHARD only. +\end{DoxyItemize} + + +\begin{DoxyItemize} +\item {\bfseries probesl \mbox{[}i\mbox{]}} gets number of probes left. Used in MYTHEN, GOTTHARD only. \end{DoxyItemize} \ No newline at end of file diff --git a/slsDetectorSoftware/slsDetectorClientDocs/latex/doxygen.sty b/slsDetectorSoftware/slsDetectorClientDocs/latex/doxygen.sty index d94925b0c..b58496031 100644 --- a/slsDetectorSoftware/slsDetectorClientDocs/latex/doxygen.sty +++ b/slsDetectorSoftware/slsDetectorClientDocs/latex/doxygen.sty @@ -24,9 +24,9 @@ \fancyplain{}{\bfseries\thepage}% } \rfoot[\fancyplain{}{\bfseries\scriptsize% - Generated on Tue Aug 15 18:28:48 2017 by Doxygen }]{} + Generated on Tue Aug 15 18:42:37 2017 by Doxygen }]{} \lfoot[]{\fancyplain{}{\bfseries\scriptsize% - Generated on Tue Aug 15 18:28:48 2017 by Doxygen }} + Generated on Tue Aug 15 18:42:37 2017 by Doxygen }} \cfoot{} %---------- Internal commands used in this style file ---------------- diff --git a/slsDetectorSoftware/slsDetectorClientDocs/latex/refman.tex b/slsDetectorSoftware/slsDetectorClientDocs/latex/refman.tex index bb61fbe10..81bd951fa 100644 --- a/slsDetectorSoftware/slsDetectorClientDocs/latex/refman.tex +++ b/slsDetectorSoftware/slsDetectorClientDocs/latex/refman.tex @@ -40,7 +40,7 @@ \vspace*{1cm} {\large Generated by Doxygen 1.6.1}\\ \vspace*{0.5cm} -{\small Tue Aug 15 18:28:48 2017}\\ +{\small Tue Aug 15 18:42:37 2017}\\ \end{center} \end{titlepage} \pagenumbering{roman}