mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-06-19 00:07:13 +02:00
comments merged
This commit is contained in:
@ -74,6 +74,31 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) {
|
||||
descrToFuncMap[i].m_pFuncName="test"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdUnderDevelopment;
|
||||
i++;
|
||||
|
||||
/*! \page test
|
||||
- <b>help</b> Returns a list of possible commands.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="help";//OK
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdHelp;
|
||||
i++;
|
||||
|
||||
/*! \page test
|
||||
- <b>exitserver</b> Shuts down all the detector servers. Don't use it!!!!
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="exitserver";//OK
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdExitServer;
|
||||
i++;
|
||||
|
||||
/*! \page test
|
||||
- <b>exitreceiver</b> Shuts down all the receivers. Don't use it!!!!
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="exitreceiver";//OK
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdExitServer;
|
||||
i++;
|
||||
|
||||
|
||||
|
||||
|
||||
/* Acquisition and status commands */
|
||||
/*! \page acquisition Acquition commands
|
||||
Commands to control the acquisition
|
||||
@ -113,11 +138,42 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) {
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdStatus;
|
||||
i++;
|
||||
|
||||
/*! \page acquisition
|
||||
- <b>readctr </b> Reads the counters from the detector memory (analog detector returning values translated into number of photons - only GOTTHARD). Cannot put.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="readctr"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdCounter;
|
||||
i++;
|
||||
|
||||
/*! \page acquisition
|
||||
- <b>resetctr i </b> Resets counter in detector, restarts acquisition if i=1(analog detector returning values translated into number of photons - only GOTTHARD). Cannot put.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="resetctr"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdCounter;
|
||||
i++;
|
||||
|
||||
/*! \page acquisition
|
||||
- <b>resmat i </b> sets/resets counter bit in detector.gets the counter bit in detector ????
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="resmat"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdCounter;
|
||||
i++;
|
||||
|
||||
|
||||
|
||||
|
||||
/*! \page config Configuration commands
|
||||
Commands to configure the detector. these commands are often left to the configuration file.
|
||||
- \ref detstructure "Detector Structure": commands to configure detector structure
|
||||
- \ref detstatus "Detector Status": commands to configure detector status
|
||||
- \ref versions "Versions": commands to check version of each subsytem
|
||||
*/
|
||||
|
||||
/* Detector structure configuration and debugging commands */
|
||||
|
||||
/*! \page config Configuration commands
|
||||
Commands to configure the detector. these commands are often left to the configuration file.
|
||||
/*! \page config
|
||||
\section detstructure Detector Structure
|
||||
commands to configure detector structure
|
||||
*/
|
||||
|
||||
/*! \page config
|
||||
@ -191,26 +247,33 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) {
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSync;
|
||||
i++;
|
||||
|
||||
/*! \page test
|
||||
- <b>help</b> Returns a list of possible commands.
|
||||
/*! \page config
|
||||
\section detstatus Detector Status
|
||||
commands to configure detector status
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="help";//OK
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdHelp;
|
||||
|
||||
/*! \page config
|
||||
- <b>online [i]</b> sets the detector in online (1) or offline (0) mode
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="online"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdOnline;
|
||||
i++;
|
||||
|
||||
/*! \page test
|
||||
- <b>exitserver</b> Shuts down all the detector servers. Don't use it!!!!
|
||||
/*! \page config
|
||||
- <b>checkonline</b> returns the hostnames of all detectors without connecting to them
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="exitserver";//OK
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdExitServer;
|
||||
descrToFuncMap[i].m_pFuncName="checkonline"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdOnline;
|
||||
i++;
|
||||
/*! \page config
|
||||
- <b>activate</b> Activates/Deactivates the detector. Deactivated detector does not send data. Used for EIGER only.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="activate"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdOnline;
|
||||
i++;
|
||||
|
||||
/*! \page test
|
||||
- <b>exitreceiver</b> Shuts down all the receivers. Don't use it!!!!
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="exitreceiver";//OK
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdExitServer;
|
||||
i++;
|
||||
|
||||
|
||||
|
||||
|
||||
/* data processing commands */
|
||||
@ -338,26 +401,10 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) {
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdImage;
|
||||
i++;
|
||||
|
||||
/*! \page acquisition
|
||||
- <b>readctr </b> Reads the counters from the detector memory (analog detector returning values translated into number of photons - only GOTTHARD). Cannot put.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="readctr"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdCounter;
|
||||
i++;
|
||||
|
||||
/*! \page acquisition
|
||||
- <b>resetctr i </b> Resets counter in detector, restarts acquisition if i=1(analog detector returning values translated into number of photons - only GOTTHARD). Cannot put.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="resetctr"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdCounter;
|
||||
i++;
|
||||
|
||||
/*! \page acquisition
|
||||
- <b>resmat i </b> sets/resets counter bit in detector.gets the counter bit in detector ????
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="resmat"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdCounter;
|
||||
i++;
|
||||
|
||||
|
||||
|
||||
/* trim/cal directories */
|
||||
|
||||
@ -423,27 +470,6 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) {
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdFileIndex;
|
||||
i++;
|
||||
|
||||
|
||||
/*! \page config
|
||||
- <b>online [i]</b> sets the detector in online (1) or offline (0) mode
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="online"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdOnline;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>checkonline</b> returns the hostnames of all detectors without connecting to them
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="checkonline"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdOnline;
|
||||
i++;
|
||||
/*! \page config
|
||||
- <b>activate</b> Activates/Deactivates the detector. Deactivated detector does not send data. Used for EIGER only.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="activate"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdOnline;
|
||||
i++;
|
||||
|
||||
/*! \page output
|
||||
- <b>enablefwrite [i]</b> Enables/disables file writing. 1 enables, 0 disables.
|
||||
*/
|
||||
@ -466,12 +492,14 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) {
|
||||
i++;
|
||||
|
||||
/*! \page output
|
||||
- <b>fileformat</b> gets the file format for data (no put?) What are the possible return values?
|
||||
- <b>fileformat</b> sets/gets the file format for data in receiver. Options: [ascii, binary, hdf5]. Ascii is not implemented in Receiver.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="fileformat"; //OK
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdFileName;
|
||||
i++;
|
||||
|
||||
|
||||
|
||||
/* Acquisition actions */
|
||||
|
||||
/*! \page actions Actions
|
||||
@ -583,10 +611,6 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) {
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdScripts;
|
||||
i++;
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
/*! \page actions
|
||||
- <b>scan0script [s]</b> sets/gets the script to be executed for the scan 0 level. \c none unsets.
|
||||
*/
|
||||
@ -659,6 +683,8 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) {
|
||||
i++;
|
||||
|
||||
|
||||
|
||||
|
||||
/* communication configuration */
|
||||
|
||||
/*! \page network Network
|
||||
@ -907,48 +933,53 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) {
|
||||
/* versions/ serial numbers getId */
|
||||
|
||||
/*! \page config
|
||||
\section versions Versions
|
||||
Commands to check versions of each subsystem
|
||||
*/
|
||||
|
||||
/*!
|
||||
- <b>moduleversion:[i]</b> Gets the firmware version of module i. Used for MYTHEN only. Only get!
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="moduleversion"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSN;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
/*!
|
||||
- <b>detectornumber</b> Gets the serial number or MAC of detector. Only get!
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="detectornumber"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSN;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
/*!
|
||||
- <b>modulenumber:[i]</b> Gets the serial number of module i. Used for MYTHEN only. Only get!
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="modulenumber"; /* find command! */
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSN;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
/*!
|
||||
- <b>detectorversion</b> Gets the firmware version of detector. Only get!
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="detectorversion"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSN;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
/*!
|
||||
- <b>softwareversion</b> Gets the software version of detector server. Only get!
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="softwareversion"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSN;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
/*!
|
||||
- <b>thisversion</b> Gets the software version of this client software. Only get!
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="thisversion"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSN;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
/*!
|
||||
- <b>receiverversion</b> Gets the software version of receiver. Only get!
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="receiverversion"; //
|
||||
@ -1660,49 +1691,49 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) {
|
||||
/* read only timers */
|
||||
|
||||
/*! \page config
|
||||
- <b>exptimel [i]</b> gets exposure time left. Used in MYTHEN, GOTTHARD only.
|
||||
- <b>exptimel</b> gets exposure time left. Used in MYTHEN, GOTTHARD only. Only get!
|
||||
*/
|
||||
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.
|
||||
- <b>periodl</b> gets frame period left. Used in MYTHEN, GOTTHARD only. Only get!
|
||||
*/
|
||||
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.
|
||||
- <b>delayl</b> gets delay left. Used in MYTHEN, GOTTHARD only. Only get!
|
||||
*/
|
||||
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.
|
||||
- <b>gatesl</b> gets number of gates left. Used in MYTHEN, GOTTHARD only. Only get!
|
||||
*/
|
||||
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.
|
||||
- <b>framesl</b> gets number of frames left. Used in MYTHEN, GOTTHARD only. Only get!
|
||||
*/
|
||||
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.
|
||||
- <b>cyclesl</b> gets number of cylces left. Used in MYTHEN, GOTTHARD only. Only get!
|
||||
*/
|
||||
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.
|
||||
- <b>probesl</b> gets number of probes left. Used in MYTHEN, GOTTHARD only. Only get!
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="probesl"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimeLeft;
|
||||
@ -1712,66 +1743,108 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) {
|
||||
// descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimer;
|
||||
// i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>now</b> ??? Only get!
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="now"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimeLeft;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>timestamp</b> ??? Only get!
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="timestamp"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimeLeft;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>nframes</b> ??? Only get!
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="nframes"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimeLeft;
|
||||
i++;
|
||||
|
||||
/* speed */
|
||||
|
||||
/*! \page config
|
||||
- <b>clkdivider [i]</b> sets/gets the readout clock divider. EIGER, JUNGFRAU [0(fast speed), 1(half speed), 2(quarter speed)]. MYTHEN[???]
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="clkdivider"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSpeed;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>clkdivider [i]</b> sets/gets length of set/reset signals (in clock cycles). Used in MYTHEN only
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="setlength"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSpeed;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>clkdivider [i]</b> sets/gets waitstates of the bus interface (in clock cycles). Used in MYTHEN only
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="waitstates"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSpeed;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>clkdivider [i]</b> sets/gets clock divider in tot mode. Used in MYTHEN only
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="totdivider"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSpeed;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>clkdivider [i]</b> sets/gets duty cycle of the tot clock. Used in MYTHEN only
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="totdutycycle"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSpeed;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>phasestep [i]</b> ???
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="phasestep"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSpeed;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>oversampling [i]</b> ???
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="oversampling"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSpeed;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>adcclk [i]</b> ???
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="adcclk"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSpeed;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>adcphase [i]</b> ??? Used in MYTHEN, JUNGFRAU only.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="adcphase"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSpeed;
|
||||
i++;
|
||||
|
||||
|
||||
/*! \page config
|
||||
- <b>adcpipeline [i]</b> ???
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="adcpipeline"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSpeed;
|
||||
i++;
|
||||
|
||||
|
||||
/*! \page config
|
||||
- <b>dbitclk [i]</b> ???
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="dbitclk"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSpeed;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>dbitphase [i]</b> ???
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="dbitphase"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSpeed;
|
||||
i++;
|
||||
@ -1782,20 +1855,33 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) {
|
||||
i++;
|
||||
|
||||
|
||||
|
||||
/* settings dump/retrieve */
|
||||
|
||||
/*! \page config
|
||||
- <b>config [fname]</b> sets/saves detector/receiver to configuration contained in fname. Same as executing sls_detector_put for every line. Normally a one time operation.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="config";
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdConfiguration;
|
||||
i++;
|
||||
|
||||
/* settings dump/retrieve */
|
||||
/*! \page config
|
||||
- <b>rx_printconfig</b> prints the receiver configuration. Only get!
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="rx_printconfig";
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdConfiguration;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>parameters [fname]</b> sets/saves detector parameters contained in fname. Normally once per different measurement.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="parameters";
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdConfiguration;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>setup [fname]</b> sets/saves detector complete setup contained in fname (extensions automatically generated), including trimfiles, ff coefficients etc.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="setup";
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdConfiguration;
|
||||
i++;
|
||||
@ -1804,52 +1890,90 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) {
|
||||
/* receiver functions */
|
||||
|
||||
/*! \page receiver Receiver commands
|
||||
Commands to configure the receiver
|
||||
Commands to configure the receiver. Not used in MYTHEN.
|
||||
*/
|
||||
|
||||
/*! \page receiver
|
||||
- <b>receiver [s]</b> starts/stops the receiver to listen to detector packets. Gets status of receiver. Options: [start, stop].
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="receiver";
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdReceiver;
|
||||
i++;
|
||||
|
||||
/*! \page receiver
|
||||
- <b>r_online [i]</b> sets/gets the receiver in online/offline mode. 1 is online, 0 is offline. Get is from shared memory.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="r_online";
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdOnline;
|
||||
i++;
|
||||
|
||||
/*! \page receiver
|
||||
- <b>r_checkonline</b> Checks the receiver if it is online/offline mode. Prints either 'All receiver online', '[List of all receiver hostname in offline mode] :Not all receiver online'. Only get!
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="r_checkonline";
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdOnline;
|
||||
i++;
|
||||
|
||||
|
||||
/*! \page receiver
|
||||
- <b>framescaught</b> gets the number of frames caught by receiver. Average of all for multi-detector command. Only get!
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="framescaught";
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdReceiver;
|
||||
i++;
|
||||
|
||||
/*! \page receiver
|
||||
- <b>resetframescaught [i]</b> resets the number of frames caught to 0. i can be any number. Use this if using status start, instead of acquire (this command is included). Only put!
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="resetframescaught";
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdReceiver;
|
||||
i++;
|
||||
|
||||
/*! \page receiver
|
||||
- <b>frameindex [i]</b> gets the current frame index of receiver. Average of all for multi-detector command. Only get!
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="frameindex";
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdReceiver;
|
||||
i++;
|
||||
|
||||
/*! \page receiver
|
||||
- <b>r_lock [i]</b> locks/unlocks the receiver to communicate with only this client. 1 locks, 0 unlocks.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="r_lock"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdLock;
|
||||
i++;
|
||||
|
||||
/*! \page receiver
|
||||
- <b>r_lastclient</b> gets the last client communicating with the receiver. Only get!
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="r_lastclient"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdLastClient;
|
||||
i++;
|
||||
|
||||
/*! \page receiver
|
||||
- <b>r_readfreq [i]</b> sets/gets the stream frequency of data from receiver to client. i > 0 is the nth frame being streamed. 0 sets frequency to a default timer (200ms).
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="r_readfreq"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdReceiver;
|
||||
i++;
|
||||
|
||||
/*! \page test
|
||||
- <b>r_compression [i] sets/gets compression in receiver. 1 sets, 0 unsets. Not implemented.</b>
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="r_compression"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdReceiver;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>tengiga [i]</b> enables/disables 10GbE in system (detector & receiver). 1 enabled 10GbE, 0 enables 1GbE. Used in EIGER only.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="tengiga"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdReceiver;
|
||||
i++;
|
||||
|
||||
/*! \page receiver
|
||||
- <b>rx_fifodepth [i]</b> sets/gets receiver fifo (between Listener and Writer Threads) depth to i number of frames. Can improve listener packet loss, not if limited by writing.
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="rx_fifodepth"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdReceiver;
|
||||
i++;
|
||||
@ -2022,14 +2146,23 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) {
|
||||
|
||||
/* pulse */
|
||||
|
||||
/*! \page config
|
||||
- <b>pulse [n] [x] [y]</b> pulses pixel at coordinates (x,y) n number of times. Used in EIGER only. Only put!"
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="pulse"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdPulse;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>pulsenmove [n] [x] [y]</b> pulses pixel n number of times and moves relatively by x value (x axis) and y value(y axis). Used in EIGER only. Only put!"
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="pulsenmove"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdPulse;
|
||||
i++;
|
||||
|
||||
/*! \page config
|
||||
- <b>pulsechip [n]</b>pulses chip n number of times, while n=-1 will reset it to normal mode. Used in EIGER only. Only put!"
|
||||
*/
|
||||
descrToFuncMap[i].m_pFuncName="pulsechip"; //
|
||||
descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdPulse;
|
||||
i++;
|
||||
@ -2317,7 +2450,7 @@ string slsDetectorCommand::cmdDataStream(int narg, char *args[], int action) {
|
||||
myDet->setReceiverOnline(ONLINE_FLAG);
|
||||
|
||||
if (action==HELP_ACTION)
|
||||
return helpStatus(narg,args,HELP_ACTION);
|
||||
return helpDataStream(narg,args,HELP_ACTION);
|
||||
|
||||
if (action==PUT_ACTION) {
|
||||
if (!sscanf(args[1],"%d",&ival))
|
||||
@ -2840,7 +2973,7 @@ string slsDetectorCommand::helpFileName(int narg, char *args[], int action){
|
||||
}
|
||||
if (action==PUT_ACTION || action==HELP_ACTION){
|
||||
os << string("fname s \t sets the filename for the data (index and extension will be automatically appended)\n");
|
||||
os << string("fname s \t sets the file format for the data (binary, ascii, hdf5)\n");
|
||||
os << string("fileformat s \t sets the file format for the data (binary, ascii, hdf5)\n");
|
||||
}
|
||||
return os.str();
|
||||
}
|
||||
@ -5686,7 +5819,7 @@ string slsDetectorCommand::helpConfiguration(int narg, char *args[], int action)
|
||||
|
||||
}
|
||||
if (action==GET_ACTION || action==HELP_ACTION) {
|
||||
|
||||
os << "rx_printconfig \t prints the receiver configuration" << std::endl;
|
||||
os << "config fname \t saves the detector to the configuration to fname" << std::endl;
|
||||
os << "parameters fname \t saves the detector parameters to fname" << std::endl;
|
||||
os << "setup fname \t saves the detector complete detector setup to fname (extensions automatically generated), including trimfiles, ff coefficients etc." << std::endl;
|
||||
|
Reference in New Issue
Block a user