#include <QwEventRing.h>

Collaboration diagram for QwEventRing:

Public Member Functions
	QwEventRing (QwOptions &options, QwSubsystemArrayParity &event)

	QwEventRing (QwSubsystemArrayParity &event, Int_t ring_size)

virtual	~QwEventRing ()

void	ProcessOptions (QwOptions &options)
	Process options. More...

void	push (QwSubsystemArrayParity &event)
	Add the subsystem to the ring. More...

QwSubsystemArrayParity &	pop ()
	Return the last subsystem in the ring. More...

Bool_t	IsReady ()
	Return the read status of the ring. More...

Static Public Member Functions
static void	DefineOptions (QwOptions &options)
	Define options. More...

Private Member Functions
	QwEventRing ()

Private Attributes
Int_t	fRING_SIZE

Int_t	fNextToBeFilled

Int_t	fNextToBeRead

Bool_t	bEVENT_READY

Bool_t	bRING_READY

std::vector < QwSubsystemArrayParity >	fEvent_Ring

QwSubsystemArrayParity	fRollingAvg

FILE *	out_file

Bool_t	bStability

Static Private Attributes
static const Bool_t	bDEBUG =kFALSE

static const Bool_t	bDEBUG_Write =kFALSE

Detailed Description

Definition at line 16 of file QwEventRing.h.

Constructor & Destructor Documentation

QwEventRing::QwEventRing ( )

private

QwEventRing::QwEventRing	(	QwOptions &	options,
		QwSubsystemArrayParity &	event
	)

Definition at line 23 of file QwEventRing.cc.

References bDEBUG_Write, bEVENT_READY, bRING_READY, fEvent_Ring, fNextToBeFilled, fNextToBeRead, fRING_SIZE, out_file, and ProcessOptions().

 : fRollingAvg(event)
 {
   ProcessOptions(options);
 
   fEvent_Ring.resize(fRING_SIZE,event);
 
   bRING_READY=kFALSE;
   bEVENT_READY=kTRUE;
   fNextToBeFilled=0;
   fNextToBeRead=0;
 
   //open the log file
   if (bDEBUG_Write)
     out_file = fopen("Ring_log.txt", "wt");
 }

Here is the call graph for this function:

QwEventRing::QwEventRing	(	QwSubsystemArrayParity &	event,
		Int_t	ring_size
	)

Definition at line 6 of file QwEventRing.cc.

References bDEBUG_Write, bEVENT_READY, bRING_READY, fEvent_Ring, fNextToBeFilled, fNextToBeRead, fRING_SIZE, and out_file.

 : fRollingAvg(event)
 {
   fRING_SIZE=ring_size;
   fEvent_Ring.resize(fRING_SIZE,event);
 
   bRING_READY=kFALSE;
   bEVENT_READY=kTRUE;
   fNextToBeFilled=0;
   fNextToBeRead=0;
   
   //open the log file
   if (bDEBUG_Write)
     out_file = fopen("Ring_log.txt", "wt");
 }

virtual QwEventRing::~QwEventRing ( )

inlinevirtual

Definition at line 30 of file QwEventRing.h.

30 { };

Member Function Documentation

void QwEventRing::DefineOptions ( QwOptions & options )

static

Define options.

Definition at line 41 of file QwEventRing.cc.

References QwOptions::AddDefaultOptions(), and QwOptions::AddOptions().

Referenced by DefineOptionsParity().

 {
   // Define the execution options
   options.AddDefaultOptions();
   options.AddOptions()("ring.size",
       po::value<int>()->default_value(4800),
       "QwEventRing: ring/buffer size");
   options.AddOptions()("ring.stability_cut",
       po::value<double>()->default_value(1),
       "QwEventRing: Stability ON/OFF");
 }

Here is the call graph for this function:

Here is the caller graph for this function:

Bool_t QwEventRing::IsReady ( )

Return the read status of the ring.

Definition at line 138 of file QwEventRing.cc.

References bRING_READY.

Referenced by main().

                            { //Check for readyness to read data from the ring using the pop() routine   
   return bRING_READY;
 }

Here is the caller graph for this function:

QwSubsystemArrayParity & QwEventRing::pop ( )

Return the last subsystem in the ring.

Definition at line 121 of file QwEventRing.cc.

References bDEBUG, bDEBUG_Write, bRING_READY, bStability, QwSubsystemArrayParity::DeaccumulateRunningSum(), QwLog::endl(), fEvent_Ring, fNextToBeRead, fRING_SIZE, fRollingAvg, out_file, and QwMessage.

Referenced by main().

                                         {
   Int_t tempIndex;
   tempIndex=fNextToBeRead;  
   if (bDEBUG) QwMessage<<" Read at "<<fNextToBeRead<<QwLog::endl; 
   if (bDEBUG_Write) fprintf(out_file," Read at %d \n",fNextToBeRead);
   
   if (fNextToBeRead==(fRING_SIZE-1)){
     bRING_READY=kFALSE;//setting to false is an extra measure of security to prevent reading a NULL value. 
   }
   if (bStability){
      fRollingAvg.DeaccumulateRunningSum(fEvent_Ring[tempIndex]);
   }
   fNextToBeRead=(fNextToBeRead+1)%fRING_SIZE;  
   return fEvent_Ring[tempIndex];  
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void QwEventRing::ProcessOptions ( QwOptions & options )

Process options.

Definition at line 53 of file QwEventRing.cc.

References bStability, fRING_SIZE, QwOptions::GetValue(), gQwOptions, and QwOptions::HasValue().

Referenced by QwEventRing().

 {
   // Reads Event Ring parameters from cmd
   Double_t stability = 0.0;
   if (gQwOptions.HasValue("ring.size"))
     fRING_SIZE=gQwOptions.GetValue<int>("ring.size");
 
   if (gQwOptions.HasValue("ring.stability_cut"))
     stability=gQwOptions.GetValue<double>("ring.stability_cut");
 
   if (stability>0.0)
     bStability=kTRUE;
   else
     bStability=kFALSE;
  
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void QwEventRing::push ( QwSubsystemArrayParity & event )

Add the subsystem to the ring.

Definition at line 69 of file QwEventRing.cc.

References QwSubsystemArrayParity::AccumulateAllRunningSum(), bDEBUG, bDEBUG_Write, bEVENT_READY, bRING_READY, bStability, QwSubsystemArrayParity::CalculateRunningAverage(), QwLog::endl(), fEvent_Ring, fNextToBeFilled, fNextToBeRead, fRING_SIZE, fRollingAvg, out_file, QwMessage, and QwSubsystemArrayParity::UpdateErrorFlag().

Referenced by main().

 {
   if (bDEBUG) QwMessage << "QwEventRing::push:  BEGIN" <<QwLog::endl;
 
   
 
   if (bEVENT_READY){
     fEvent_Ring[fNextToBeFilled]=event;//copy the current good event to the ring 
     if (bStability){
       fRollingAvg.AccumulateAllRunningSum(event);
     }
 
 
     if (bDEBUG) QwMessage<<" Filled at "<<fNextToBeFilled;//<<"Ring count "<<fRing_Count<<QwLog::endl; 
     if (bDEBUG_Write) fprintf(out_file," Filled at %d ",fNextToBeFilled);
 
 
     fNextToBeFilled=(fNextToBeFilled+1)%fRING_SIZE;
     
     if(fNextToBeFilled == 0){
       //then we have RING_SIZE events to process
       if (bDEBUG) QwMessage<<" RING FILLED "<<fNextToBeFilled+1; //<<QwLog::endl; 
       if (bDEBUG_Write) fprintf(out_file," RING FILLED ");
       bRING_READY=kTRUE;//ring is filled with good multiplets
       fNextToBeFilled=0;//next event to be filled
       fNextToBeRead=0;//first element in the ring  
       //check for current ramps
       if (bStability){
   fRollingAvg.CalculateRunningAverage();
   /*
   //The fRollingAvg dose not contain any regular errorcodes since it only accumulate rolling sum for errorflag==0 event.
   //The only errorflag it generates is the stability cut faliure error when the rolling avg is computed. 
   //Therefore when fRollingAvg.GetEventcutErrorFlag() is called it will return non-zero error code only if a global stability cut has failed
   //When fRollingAvg.GetEventcutErrorFlag() is called the fErrorFlag of the subsystemarrayparity object will be updated with any global
   //stability cut faliures
   */
   fRollingAvg.UpdateErrorFlag(); //to update the global error code in the fRollingAvg
   for(Int_t i=0;i<fRING_SIZE;i++){
     fEvent_Ring[i].UpdateErrorFlag(fRollingAvg);
     fEvent_Ring[i].UpdateErrorFlag();
   }
   
       }
     }
     //ring processing is done at a separate location
   }else{
   }
   
   
 }