From 7115ac19b6251ede868adff452c462fe9a051e25 Mon Sep 17 00:00:00 2001 From: Dhanya Maliakal Date: Thu, 17 Aug 2017 17:02:42 +0200 Subject: [PATCH] command line docu. more coming up --- .../slsDetector/slsDetectorCommand.cpp | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/slsDetectorSoftware/slsDetector/slsDetectorCommand.cpp b/slsDetectorSoftware/slsDetector/slsDetectorCommand.cpp index 1bad177e3..f77dea947 100644 --- a/slsDetectorSoftware/slsDetector/slsDetectorCommand.cpp +++ b/slsDetectorSoftware/slsDetector/slsDetectorCommand.cpp @@ -1972,21 +1972,21 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) { */ /*! \page receiver - - receiver [s] starts/stops the receiver to listen to detector packets. Gets status of receiver. Options: [start, stop]. + - receiver [s] starts/stops the receiver to listen to detector packets. Options: [ \c start, \c stop]. \c Returns \c (string) status of receiver[ \c idle, \c running]. */ descrToFuncMap[i].m_pFuncName="receiver"; descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdReceiver; i++; /*! \page receiver - - r_online [i] sets/gets the receiver in online/offline mode. 1 is online, 0 is offline. Get is from shared memory. + - r_online [i] sets/gets the receiver in online/offline mode. 1 is online, 0 is offline. Get is from shared memory. \c Returns \c (int) */ descrToFuncMap[i].m_pFuncName="r_online"; descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdOnline; i++; /*! \page receiver - - r_checkonline 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! + - r_checkonline Checks the receiver if it is online/offline mode. Only get! \c Returns (string) "All online" or "[list of offline hostnames] : Not online". */ descrToFuncMap[i].m_pFuncName="r_checkonline"; descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdOnline; @@ -1994,49 +1994,49 @@ slsDetectorCommand::slsDetectorCommand(slsDetectorUtils *det) { /*! \page receiver - - framescaught gets the number of frames caught by receiver. Average of all for multi-detector command. Only get! + - framescaught gets the number of frames caught by receiver. Average of all for multi-detector command. Only get! \c Returns \c (int) */ descrToFuncMap[i].m_pFuncName="framescaught"; descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdReceiver; i++; /*! \page receiver - - resetframescaught [i] 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! + - resetframescaught [i] 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! \c Returns \c (int) */ descrToFuncMap[i].m_pFuncName="resetframescaught"; descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdReceiver; i++; /*! \page receiver - - frameindex [i] gets the current frame index of receiver. Average of all for multi-detector command. Only get! + - frameindex [i] gets the current frame index of receiver. Average of all for multi-detector command. Only get! \c Returns \c (int) */ descrToFuncMap[i].m_pFuncName="frameindex"; descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdReceiver; i++; /*! \page receiver - - r_lock [i] locks/unlocks the receiver to communicate with only this client. 1 locks, 0 unlocks. + - r_lock [i] locks/unlocks the receiver to communicate with only this client. 1 locks, 0 unlocks. \c Returns \c (int) */ descrToFuncMap[i].m_pFuncName="r_lock"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdLock; i++; /*! \page receiver - - r_lastclient gets the last client communicating with the receiver. Only get! + - r_lastclient gets the last client communicating with the receiver. Only get! \c Returns \c (int) */ descrToFuncMap[i].m_pFuncName="r_lastclient"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdLastClient; i++; /*! \page receiver - - r_readfreq [i] 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). + - r_readfreq [i] 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). \c Returns \c (int) */ descrToFuncMap[i].m_pFuncName="r_readfreq"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdReceiver; i++; /*! \page receiver - - rx_fifodepth [i] 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. + - rx_fifodepth [i] sets/gets receiver fifo (between Listener and Writer Threads) depth to i number of frames. Can improve listener packet loss (loss due to packet processing time in Listener threads), not if limited by writing. \c Returns \c (int) */ descrToFuncMap[i].m_pFuncName="rx_fifodepth"; // descrToFuncMap[i].m_pFuncPtr=&slsDetectorCommand::cmdReceiver;