doxygen for slsReceiver and slsReceiverInterface

git-svn-id: file:///afs/psi.ch/project/sls_det_software/svn/slsDetectorSoftware@315 951219d9-93cf-4727-9268-0efd64621fa3
This commit is contained in:
l_maliakal_d
2012-10-26 09:38:54 +00:00
parent 83775bd7f3
commit 8387f70071
8 changed files with 22 additions and 17 deletions

View File

@ -5624,7 +5624,7 @@ slsDetectorDefs::runStatus slsDetector::getReceiverStatus(){
int slsDetector::getFramesCaughtByReciver(){
int slsDetector::getFramesCaughtByReceiver(){
int fnum=F_GET_FRAMES_CAUGHT;
int ret = FAIL;
int retval=-1;

View File

@ -1452,7 +1452,7 @@ class slsDetector : public slsDetectorUtils, public energyConversion {
/** gets the number of frames caught by receiver
\returns number of frames caught by receiver
*/
int getFramesCaughtByReciver();
int getFramesCaughtByReceiver();
/** Locks/Unlocks the connection to the receiver
/param lock sets (1), usets (0), gets (-1) the lock

View File

@ -3517,7 +3517,7 @@ string slsDetectorCommand::cmdReceiver(int narg, char *args[], int action) {
if (action==PUT_ACTION)
return string("cannot put");
else{
sprintf(answer,"%d",myDet->getFramesCaughtByReciver());
sprintf(answer,"%d",myDet->getFramesCaughtByReceiver());
return string(answer);
}
}
@ -3535,7 +3535,7 @@ string slsDetectorCommand::helpReceiver(int narg, char *args[], int action) {
os << "receiver [status] \t starts/stops the receiver to listen to detector packets. - can be start or stop" << std::endl;
if (action==GET_ACTION || action==HELP_ACTION){
os << "receiver \t returns the status of receiver - can be running or idle" << std::endl;
os << "framescaught \t returns the number of frames caught by receiver" << std::endl;
os << "framescaught \t returns the number of frames caught by receiver(average for multi)" << std::endl;
}
return os.str();

View File

@ -610,7 +610,10 @@ class slsDetectorUtils : public slsDetectorActions, public postProcessing {
*/
virtual string getFileName()=0;
/**
\returns frames caught by receiver(average for multi)
*/
virtual int getFramesCaughtByReceiver()=0;
protected: