mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-04-23 06:50:02 +02:00
more changes to client docu. more coming up
This commit is contained in:
Dhanya Maliakal
parent
f8060ef757
commit
bb917b70f3
@ -1380,77 +1380,130 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) {
|
||||
|
||||
/* r/w timers */
|
||||
|
||||
/*! \page config
|
||||
- <b>timing [mode]</b> 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
|
||||
- <b>exptime [i]</b> sets/gets exposure time in s
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="exptime"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimer;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>subexptime [i]</b> 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
|
||||
- <b>period [i]</b> sets/gets frame period in s.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="period"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimer;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>delay [i]</b> sets/gets delay in s. Used in MYTHEN, GOTTHARD only
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="delay"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimer;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>gates [i]</b> 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
|
||||
- <b>gates [i]</b> 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
|
||||
- <b>cycles [i]</b> 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
|
||||
- <b>probes [i]</b> 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
|
||||
- <b>measurements [i]</b> sets/gets number of measurements.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="measurements"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimer;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>samples [i]</b> 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
|
||||
- <b>exptimel [i]</b> gets exposure time left. Used in MYTHEN, GOTTHARD only.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="exptimel"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimeLeft;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>periodl [i]</b> gets frame period left. Used in MYTHEN, GOTTHARD only.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="periodl"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimeLeft;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>delayl [i]</b> gets delay left. Used in MYTHEN, GOTTHARD only.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="delayl"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimeLeft;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>gatesl [i]</b> gets number of gates left. Used in MYTHEN, GOTTHARD only.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="gatesl"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimeLeft;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>framesl [i]</b> gets number of frames left. Used in MYTHEN, GOTTHARD only.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="framesl"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimeLeft;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>cyclesl [i]</b> gets number of cylces left. Used in MYTHEN, GOTTHARD only.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="cyclesl"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimeLeft;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>probesl [i]</b> gets number of probes left. Used in MYTHEN, GOTTHARD only.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="probesl"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimeLeft;
|
||||
i++;
|
||||
|
||||
@ -137,7 +137,61 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||||
<li><b>thisversion</b> Gets the software version of this client software. Only get!</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>receiverversion</b> Gets the software version of receiver. Only get! </li>
|
||||
<li><b>receiverversion</b> Gets the software version of receiver. Only get!</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>timing [mode]</b> sets/gets synchronization mode of the detector. Mode: auto, trigger, ro_trigger, gating, triggered_gating</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>exptime [i]</b> sets/gets exposure time in s</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>subexptime [i]</b> sets/gets sub exposure time in s. Used in EIGER only in 32 bit mode.</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>period [i]</b> sets/gets frame period in s.</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>delay [i]</b> sets/gets delay in s. Used in MYTHEN, GOTTHARD only</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>gates [i]</b> sets/gets number of gates. Used in MYTHEN, GOTTHARD, EIGER only</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>gates [i]</b> sets/gets number of frames. If <code>timing</code> is not <code>auto</code>, then it is the number of frames per cycle/trigger.</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>cycles [i]</b> sets/gets number of triggers. Timing mode should be set appropriately.</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>probes [i]</b> 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</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>measurements [i]</b> sets/gets number of measurements.</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>samples [i]</b> sets/gets number of samples expected from the jctb. Used in CHIP TEST BOARD only.</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>exptimel [i]</b> gets exposure time left. Used in MYTHEN, GOTTHARD only.</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>periodl [i]</b> gets frame period left. Used in MYTHEN, GOTTHARD only.</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>delayl [i]</b> gets delay left. Used in MYTHEN, GOTTHARD only.</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>gatesl [i]</b> gets number of gates left. Used in MYTHEN, GOTTHARD only.</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>framesl [i]</b> gets number of frames left. Used in MYTHEN, GOTTHARD only.</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>cyclesl [i]</b> gets number of cylces left. Used in MYTHEN, GOTTHARD only.</li>
|
||||
</ul>
|
||||
<ul>
|
||||
<li><b>probesl [i]</b> gets number of probes left. Used in MYTHEN, GOTTHARD only. </li>
|
||||
</ul>
|
||||
</div>
|
||||
<!--- window showing the filter options -->
|
||||
|
||||
@ -165,3 +165,93 @@ 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!
|
||||
\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}
|
||||
@ -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 ----------------
|
||||
|
||||
@ -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}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user