diff --git a/slsDetectorSoftware/slsDetector/slsDetectorCommand.cpp b/slsDetectorSoftware/slsDetector/slsDetectorCommand.cpp index aa900d25e..a91b6d270 100644 --- a/slsDetectorSoftware/slsDetector/slsDetectorCommand.cpp +++ b/slsDetectorSoftware/slsDetector/slsDetectorCommand.cpp @@ -464,7 +464,7 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) { i++; /*! \page output - - fileformat gets the file format for data (no put?) What are the possible return values? + - fileformat 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; @@ -1460,49 +1460,49 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) { /* read only timers */ /*! \page config - - exptimel [i] gets exposure time left. Used in MYTHEN, GOTTHARD only. Only get! + - exptimel 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 - - periodl [i] gets frame period left. Used in MYTHEN, GOTTHARD only. Only get! + - periodl 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 - - delayl [i] gets delay left. Used in MYTHEN, GOTTHARD only. Only get! + - delayl gets delay left. Used in MYTHEN, GOTTHARD only. Only get! */ 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. Only get! + - gatesl 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 - - framesl [i] gets number of frames left. Used in MYTHEN, GOTTHARD only. Only get! + - framesl 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 - - cyclesl [i] gets number of cylces left. Used in MYTHEN, GOTTHARD only. Only get! + - cyclesl 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 - - probesl [i] gets number of probes left. Used in MYTHEN, GOTTHARD only. Only get! + - probesl gets number of probes left. Used in MYTHEN, GOTTHARD only. Only get! */ descrToFuncMap[i].m_pFuncName="probesl"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimeLeft; @@ -1513,68 +1513,107 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) { // i++; /*! \page config - - now [i] ??? Only get! + - now ??? Only get! */ descrToFuncMap[i].m_pFuncName="now"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimeLeft; i++; + /*! \page config + - timestamp ??? Only get! + */ descrToFuncMap[i].m_pFuncName="timestamp"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimeLeft; i++; + /*! \page config + - nframes ??? Only get! + */ descrToFuncMap[i].m_pFuncName="nframes"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdTimeLeft; i++; /* speed */ - + /*! \page config + - clkdivider [i] 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 + - clkdivider [i] 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 + - clkdivider [i] 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 + - clkdivider [i] 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 + - clkdivider [i] 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 + - phasestep [i] ??? + */ descrToFuncMap[i].m_pFuncName="phasestep"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSpeed; i++; + /*! \page config + - oversampling [i] ??? + */ descrToFuncMap[i].m_pFuncName="oversampling"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSpeed; i++; + /*! \page config + - adcclk [i] ??? + */ descrToFuncMap[i].m_pFuncName="adcclk"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSpeed; i++; + /*! \page config + - adcphase [i] ??? Used in MYTHEN, JUNGFRAU only. + */ descrToFuncMap[i].m_pFuncName="adcphase"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSpeed; i++; - + /*! \page config + - adcpipeline [i] ??? + */ descrToFuncMap[i].m_pFuncName="adcpipeline"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSpeed; i++; - + /*! \page config + - dbitclk [i] ??? + */ descrToFuncMap[i].m_pFuncName="dbitclk"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSpeed; i++; + /*! \page config + - dbitphase [i] ??? + */ descrToFuncMap[i].m_pFuncName="dbitphase"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdSpeed; i++; @@ -1585,20 +1624,33 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) { i++; - /* settings dump/retrieve */ + + /*! \page config + - config [fname] 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 + - rx_printconfig prints the receiver configuration. Only get!" + */ descrToFuncMap[i].m_pFuncName="rx_printconfig"; descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdConfiguration; i++; + /*! \page config + - parameters [fname] 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 + - setup [fname] 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++; @@ -2577,7 +2629,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(); } @@ -5423,7 +5475,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;