mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-05-12 07:30:03 +02:00
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:
parent
83775bd7f3
commit
8387f70071
@ -80,7 +80,7 @@ LATEX_HIDE_INDICES = YES
|
|||||||
|
|
||||||
PREDEFINED = __cplusplus
|
PREDEFINED = __cplusplus
|
||||||
|
|
||||||
INPUT = slsDetector/slsDetectorUsers.h slsDetector/slsDetectorBase.h commonFiles/sls_detector_defs.h slsDetector/slsDetector.h MySocketTCP/MySocketTCP.h usersFunctions/usersFunctions.h multiSlsDetector/multiSlsDetector.h commonFiles/sls_detector_defs.h slsDetector/slsDetectorUtils.h slsDetector/slsDetectorBase.h slsDetector/slsDetectorCommand.h slsDetector/slsDetectorActions.h multiSlsDetector/multiSlsDetector.h slsDetectorAnalysis/detectorData.h slsDetectorAnalysis/energyConversion.h slsDetectorAnalysis/postProcessing.h slsDetectorAnalysis/angularConversion.h slsDetectorAnalysis/fileIO.h multiSlsDetector/multiSlsDetectorClient.h multiSlsDetector/multiSlsDetectorCommand.h slsDetectorAnalysis/angularConversionStatic.h slsDetectorAnalysis/angleConversionConstant.h slsDetectorAnalysis/enCalLogClass.h slsDetectorAnalysis/angCalLogClass.h slsDetectorAnalysis/badChannelCorrections.h slsDetectorAnalysis/fileIOStatic.h
|
INPUT = slsDetector/slsDetectorUsers.h slsDetector/slsDetectorBase.h commonFiles/sls_detector_defs.h slsDetector/slsDetector.h MySocketTCP/MySocketTCP.h usersFunctions/usersFunctions.h multiSlsDetector/multiSlsDetector.h commonFiles/sls_detector_defs.h slsDetector/slsDetectorUtils.h slsDetector/slsDetectorBase.h slsDetector/slsDetectorCommand.h slsDetector/slsDetectorActions.h multiSlsDetector/multiSlsDetector.h slsDetectorAnalysis/detectorData.h slsDetectorAnalysis/energyConversion.h slsDetectorAnalysis/postProcessing.h slsDetectorAnalysis/angularConversion.h slsDetectorAnalysis/fileIO.h multiSlsDetector/multiSlsDetectorClient.h multiSlsDetector/multiSlsDetectorCommand.h slsDetectorAnalysis/angularConversionStatic.h slsDetectorAnalysis/angleConversionConstant.h slsDetectorAnalysis/enCalLogClass.h slsDetectorAnalysis/angCalLogClass.h slsDetectorAnalysis/badChannelCorrections.h slsDetectorAnalysis/fileIOStatic.h slsReceiverInterface/receiverInterface.h slsReceiver/slsReceiver_funcs.h slsReceiver/slsReceiverFunctionList.h
|
||||||
|
|
||||||
OUTPUT_DIRECTORY = docs
|
OUTPUT_DIRECTORY = docs
|
||||||
|
|
||||||
|
@ -3673,15 +3673,14 @@ slsDetectorDefs::runStatus multiSlsDetector::getReceiverStatus(){
|
|||||||
|
|
||||||
|
|
||||||
int multiSlsDetector::getFramesCaughtByReciver() {
|
int multiSlsDetector::getFramesCaughtByReciver() {
|
||||||
int ret=-100,ret1;
|
int ret=0,ret1=0;
|
||||||
for (int i=0; i<thisMultiDetector->numberOfDetectors; i++)
|
for (int i=0; i<thisMultiDetector->numberOfDetectors; i++)
|
||||||
if (detectors[i]){
|
if (detectors[i])
|
||||||
ret1=detectors[i]->getFramesCaughtByReciver();
|
ret1+=detectors[i]->getFramesCaughtByReceiver();
|
||||||
if(ret==-100)
|
|
||||||
ret=ret1;
|
if(!thisMultiDetector->numberOfDetectors)
|
||||||
else if (ret!=ret1)
|
return ret;
|
||||||
ret=-1;
|
ret=(int)(ret1/thisMultiDetector->numberOfDetectors);
|
||||||
}
|
|
||||||
|
|
||||||
return ret;
|
return ret;
|
||||||
}
|
}
|
||||||
|
@ -1076,7 +1076,7 @@ class multiSlsDetector : public slsDetectorUtils {
|
|||||||
/** gets the number of frames caught by receiver
|
/** gets the number of frames caught by receiver
|
||||||
\returns number of frames caught by receiver
|
\returns number of frames caught by receiver
|
||||||
*/
|
*/
|
||||||
int getFramesCaughtByReciver();
|
int getFramesCaughtByReceiver();
|
||||||
|
|
||||||
/** Locks/Unlocks the connection to the receiver
|
/** Locks/Unlocks the connection to the receiver
|
||||||
/param lock sets (1), usets (0), gets (-1) the lock
|
/param lock sets (1), usets (0), gets (-1) the lock
|
||||||
|
@ -5624,7 +5624,7 @@ slsDetectorDefs::runStatus slsDetector::getReceiverStatus(){
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
int slsDetector::getFramesCaughtByReciver(){
|
int slsDetector::getFramesCaughtByReceiver(){
|
||||||
int fnum=F_GET_FRAMES_CAUGHT;
|
int fnum=F_GET_FRAMES_CAUGHT;
|
||||||
int ret = FAIL;
|
int ret = FAIL;
|
||||||
int retval=-1;
|
int retval=-1;
|
||||||
|
@ -1452,7 +1452,7 @@ class slsDetector : public slsDetectorUtils, public energyConversion {
|
|||||||
/** gets the number of frames caught by receiver
|
/** gets the number of frames caught by receiver
|
||||||
\returns number of frames caught by receiver
|
\returns number of frames caught by receiver
|
||||||
*/
|
*/
|
||||||
int getFramesCaughtByReciver();
|
int getFramesCaughtByReceiver();
|
||||||
|
|
||||||
/** Locks/Unlocks the connection to the receiver
|
/** Locks/Unlocks the connection to the receiver
|
||||||
/param lock sets (1), usets (0), gets (-1) the lock
|
/param lock sets (1), usets (0), gets (-1) the lock
|
||||||
|
@ -3517,7 +3517,7 @@ string slsDetectorCommand::cmdReceiver(int narg, char *args[], int action) {
|
|||||||
if (action==PUT_ACTION)
|
if (action==PUT_ACTION)
|
||||||
return string("cannot put");
|
return string("cannot put");
|
||||||
else{
|
else{
|
||||||
sprintf(answer,"%d",myDet->getFramesCaughtByReciver());
|
sprintf(answer,"%d",myDet->getFramesCaughtByReceiver());
|
||||||
return string(answer);
|
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;
|
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){
|
if (action==GET_ACTION || action==HELP_ACTION){
|
||||||
os << "receiver \t returns the status of receiver - can be running or idle" << std::endl;
|
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();
|
return os.str();
|
||||||
|
|
||||||
|
@ -610,7 +610,10 @@ class slsDetectorUtils : public slsDetectorActions, public postProcessing {
|
|||||||
*/
|
*/
|
||||||
virtual string getFileName()=0;
|
virtual string getFileName()=0;
|
||||||
|
|
||||||
|
/**
|
||||||
|
\returns frames caught by receiver(average for multi)
|
||||||
|
*/
|
||||||
|
virtual int getFramesCaughtByReceiver()=0;
|
||||||
|
|
||||||
protected:
|
protected:
|
||||||
|
|
||||||
|
@ -17,7 +17,7 @@
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@short interface between sls detector and sls receiver
|
@short
|
||||||
*/
|
*/
|
||||||
class receiverInterface{
|
class receiverInterface{
|
||||||
|
|
||||||
@ -35,7 +35,10 @@ public:
|
|||||||
*/
|
*/
|
||||||
virtual ~receiverInterface();
|
virtual ~receiverInterface();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set the datasocket
|
||||||
|
* @param socket the data socket
|
||||||
|
*/
|
||||||
void setSocket(MySocketTCP *socket){dataSocket=socket;};
|
void setSocket(MySocketTCP *socket){dataSocket=socket;};
|
||||||
|
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user