QwHaloMonitor Class Reference

#include <QwHaloMonitor.h>

Inheritance diagram for QwHaloMonitor:

Collaboration diagram for QwHaloMonitor:

Public Member Functions
	QwHaloMonitor ()
	QwHaloMonitor (TString name)
	QwHaloMonitor (TString subsystemname, TString name)
	QwHaloMonitor (const QwHaloMonitor &source)
virtual	~QwHaloMonitor ()
void	InitializeChannel (TString name)
void	InitializeChannel (TString subsystem, TString name)
void	ClearEventData ()
	Clear the event data in this element. More...
void	LoadChannelParameters (QwParameterFile &paramfile)
std::string	GetExternalClockName ()
Bool_t	NeedsExternalClock ()
void	SetExternalClockPtr (const VQwHardwareChannel *clock)
void	SetExternalClockName (const std::string name)
Double_t	GetNormClockValue ()
void	PrintErrorCounters ()
void	UpdateHWErrorCount ()
Int_t	ProcessEvBuffer (UInt_t *buffer, UInt_t num_words_left, UInt_t index=0)
	Process the CODA event buffer for this element. More...
void	ProcessEvent ()
QwHaloMonitor &	operator= (const QwHaloMonitor &value)
QwHaloMonitor &	operator+= (const QwHaloMonitor &value)
QwHaloMonitor &	operator-= (const QwHaloMonitor &value)
void	Sum (QwHaloMonitor &value1, QwHaloMonitor &value2)
void	Difference (QwHaloMonitor &value1, QwHaloMonitor &value2)
void	Ratio (QwHaloMonitor &numer, QwHaloMonitor &denom)
void	Offset (Double_t Offset)
void	Scale (Double_t Offset)
void	SetPedestal (Double_t ped)
void	SetCalibrationFactor (Double_t factor)
void	AccumulateRunningSum (const QwHaloMonitor &value)
void	DeaccumulateRunningSum (QwHaloMonitor &value)
void	CalculateRunningAverage ()
Bool_t	ApplySingleEventCuts ()
void	IncrementErrorCounters ()
UInt_t	GetEventcutErrorFlag ()
	return the error flag on this channel/device More...
UInt_t	UpdateErrorFlag ()
	Update the error flag based on the error flags of internally contained objects Return paramter is the "Eventcut Error Flag". More...
void	UpdateErrorFlag (const QwHaloMonitor *ev_error)
void	PrintErrorCounters () const
	report number of events failed due to HW and event cut failure More...
Bool_t	ApplyHWChecks ()
void	SetSingleEventCuts (UInt_t errorflag, Double_t min, Double_t max, Double_t stability)
	set the upper and lower limits (fULimit and fLLimit), stability % and the error flag on this channel More...
void	SetEventCutMode (Int_t bcuts)
void	ConstructHistograms (TDirectory *folder, TString &prefix)
	Construct the histograms for this data element. More...
void	FillHistograms ()
	Fill the histograms for this data element. More...
void	ConstructBranchAndVector (TTree *tree, TString &prefix, std::vector< Double_t > &values)
void	ConstructBranch (TTree *tree, TString &prefix)
void	ConstructBranch (TTree *tree, TString &prefix, QwParameterFile &modulelist)
void	FillTreeVector (std::vector< Double_t > &values) const
VQwHardwareChannel *	GetScaler ()
const VQwHardwareChannel *	GetScaler () const
Double_t	GetValue ()
void	PrintValue () const
	Print single line of value and error of this data element. More...
void	PrintInfo () const
	Print multiple lines of information about this data element. More...
std::vector< QwDBInterface >	GetDBEntry ()
std::vector< QwErrDBInterface >	GetErrDBEntry ()
Public Member Functions inherited from VQwDataElement
	VQwDataElement ()
	Default constructor. More...
	VQwDataElement (const VQwDataElement &value)
	Copy constructor. More...
virtual	~VQwDataElement ()
	Virtual destructor. More...
Bool_t	IsNameEmpty () const
	Is the name of this element empty? More...
void	SetElementName (const TString &name)
	Set the name of this element. More...
virtual const TString &	GetElementName () const
	Get the name of this element. More...
size_t	GetNumberOfDataWords ()
	Get the number of data words in this data element. More...
UInt_t	GetGoodEventCount () const
virtual void	AssignValueFrom (const VQwDataElement *valueptr)
virtual VQwDataElement &	operator+= (const VQwDataElement &value)
	Addition-assignment operator. More...
virtual VQwDataElement &	operator-= (const VQwDataElement &value)
	Subtraction-assignment operator. More...
virtual void	Sum (const VQwDataElement &value1, const VQwDataElement &value2)
	Sum operator. More...
virtual void	Difference (const VQwDataElement &value1, const VQwDataElement &value2)
	Difference operator. More...
virtual void	Ratio (const VQwDataElement &numer, const VQwDataElement &denom)
	Ratio operator. More...
virtual void	SetNeedsExternalClock (Bool_t needed)
TString	GetSubsystemName () const
	Return the name of the inheriting subsystem name. More...
void	SetSubsystemName (TString sysname)
	Set the name of the inheriting subsystem name. More...
TString	GetModuleType () const
	Return the type of the beam instrument. More...
void	SetModuleType (TString ModuleType)
	set the type of the beam instrument More...
Public Member Functions inherited from MQwHistograms
void	ShareHistograms (const MQwHistograms *source)
	Share histogram pointers between objects. More...

Private Attributes
QwSIS3801D24_Channel	fHalo_Counter
Int_t	fDeviceErrorCode
Bool_t	bEVENTCUTMODE

Static Private Attributes
static const Bool_t	kDEBUG

Additional Inherited Members
Public Types inherited from VQwDataElement
enum	EDataToSave { kRaw = 0, kDerived }
Protected Member Functions inherited from VQwDataElement
void	SetNumberOfDataWords (const UInt_t &numwords)
	Set the number of data words in this data element. More...
virtual VQwDataElement &	operator= (const VQwDataElement &value)
	Arithmetic assignment operator: Should only copy event-based data. More...
virtual void	UpdateErrorFlag (const UInt_t &error)
Protected Member Functions inherited from MQwHistograms
	MQwHistograms ()
	Default constructor. More...
	MQwHistograms (const MQwHistograms &source)
	Copy constructor. More...
virtual	~MQwHistograms ()
	Virtual destructor. More...
virtual MQwHistograms &	operator= (const MQwHistograms &value)
void	Fill_Pointer (TH1_ptr hist_ptr, Double_t value)
void	AddHistogram (TH1 *h)
	Register a histogram. More...
Protected Attributes inherited from VQwDataElement
TString	fElementName
	Name of this data element. More...
UInt_t	fNumberOfDataWords
	Number of raw data words in this data element. More...
Int_t	fGoodEventCount
	Number of good events accumulated in this element. More...
TString	fSubsystemName
TString	fModuleType
UInt_t	fErrorFlag
	This the standard error code generated for the channel that contains the global/local/stability flags and the Device error code (Unique error code for HW failures) More...
UInt_t	fErrorConfigFlag
	contains the global/local/stability flags More...
Protected Attributes inherited from MQwHistograms
std::vector< TH1_ptr >	fHistograms
	Histograms associated with this data element. More...

Detailed Description

Definition at line 31 of file QwHaloMonitor.h.

Constructor & Destructor Documentation

QwHaloMonitor::QwHaloMonitor ( )

inline

Definition at line 35 of file QwHaloMonitor.h.

{ };

QwHaloMonitor::QwHaloMonitor ( TString  name )

inline

Definition at line 36 of file QwHaloMonitor.h.

References InitializeChannel().

                             {
    InitializeChannel(name);
  };

Here is the call graph for this function:

QwHaloMonitor::QwHaloMonitor ( TString  subsystemname, TString  name  )

inline

Definition at line 39 of file QwHaloMonitor.h.

References InitializeChannel().

                                                    {
    InitializeChannel(subsystemname, name);
  };

Here is the call graph for this function:

QwHaloMonitor::QwHaloMonitor ( const QwHaloMonitor &  source )

inline

Definition at line 42 of file QwHaloMonitor.h.

  : VQwDataElement(source),
    fHalo_Counter(source.fHalo_Counter)
  { }

virtual QwHaloMonitor::~QwHaloMonitor ( )

inlinevirtual

Definition at line 46 of file QwHaloMonitor.h.

{ };

Member Function Documentation

void QwHaloMonitor::AccumulateRunningSum

(

const QwHaloMonitor &

value

)

Definition at line 110 of file QwHaloMonitor.cc.

References fHalo_Counter.

                                                                   {
  fHalo_Counter.AccumulateRunningSum(value.fHalo_Counter);
}

Bool_t QwHaloMonitor::ApplyHWChecks

(

)

Definition at line 43 of file QwHaloMonitor.cc.

{
  Bool_t eventokay=kTRUE;
  return eventokay;
}

Bool_t QwHaloMonitor::ApplySingleEventCuts

(

)

Definition at line 50 of file QwHaloMonitor.cc.

References fHalo_Counter.

{
  return fHalo_Counter.ApplySingleEventCuts();
}

void QwHaloMonitor::CalculateRunningAverage

(

)

Definition at line 118 of file QwHaloMonitor.cc.

References fHalo_Counter.

                                           {
  fHalo_Counter.CalculateRunningAverage();
}

void QwHaloMonitor::ClearEventData ( )

virtual

Clear the event data in this element.

Reimplemented from VQwDataElement.

Definition at line 26 of file QwHaloMonitor.cc.

References fHalo_Counter.

{
  fHalo_Counter.ClearEventData();
}

void QwHaloMonitor::ConstructBranch	(	TTree *	tree,
		TString &	prefix
	)

Definition at line 165 of file QwHaloMonitor.cc.

References fHalo_Counter, and VQwDataElement::GetElementName().

{
  if (GetElementName()==""){
    //  This channel is not used, so skip filling the histograms.
  }
  else{
    fHalo_Counter.ConstructBranch(tree, prefix);
    // this functions doesn't do anything yet
  }
}

Here is the call graph for this function:

void QwHaloMonitor::ConstructBranch	(	TTree *	tree,
		TString &	prefix,
		QwParameterFile &	modulelist
	)

Definition at line 178 of file QwHaloMonitor.cc.

References QwLog::endl(), fHalo_Counter, VQwDataElement::GetElementName(), QwParameterFile::HasValue(), and QwMessage.

{
  TString devicename;

  devicename=GetElementName();
  devicename.ToLower();
  if (GetElementName()==""){
    //  This channel is not used, so skip filling the histograms.
  } else {

    //QwMessage <<" QwHaloMonitor "<<devicename<<QwLog::endl;
    if (modulelist.HasValue(devicename)){
      fHalo_Counter.ConstructBranch(tree, prefix);
      QwMessage <<" Tree leaf added to "<<devicename<<QwLog::endl;
    }
    // this functions doesn't do anything yet
  }
}

Here is the call graph for this function:

void QwHaloMonitor::ConstructBranchAndVector	(	TTree *	tree,
		TString &	prefix,
		std::vector< Double_t > &	values
	)

Definition at line 154 of file QwHaloMonitor.cc.

References fHalo_Counter, and VQwDataElement::GetElementName().

{
  if (GetElementName()==""){
    //  This channel is not used, so skip filling the histograms.
  }
  else{
    fHalo_Counter.ConstructBranchAndVector(tree, prefix,values);
    // this functions doesn't do anything yet
  }
}

Here is the call graph for this function:

void QwHaloMonitor::ConstructHistograms ( TDirectory *  folder, TString &  prefix  )

virtual

Construct the histograms for this data element.

Implements VQwDataElement.

Definition at line 134 of file QwHaloMonitor.cc.

References fHalo_Counter, and VQwDataElement::GetElementName().

{
  if (GetElementName()==""){
    //  This channel is not used, so skip filling the histograms.
  }
  else{
      fHalo_Counter.ConstructHistograms(folder, prefix);
  }
}

Here is the call graph for this function:

void QwHaloMonitor::DeaccumulateRunningSum

(

QwHaloMonitor &

value

)

Definition at line 114 of file QwHaloMonitor.cc.

                                                               {
  //fHalo_Counter.DeccumulateRunningSum(value.fHalo_Counter);
}

void QwHaloMonitor::Difference	(	QwHaloMonitor &	value1,
		QwHaloMonitor &	value2
	)

Definition at line 92 of file QwHaloMonitor.cc.

                                                                          {
  *this =  value1;
  *this -= value2;
}

void QwHaloMonitor::FillHistograms ( )

virtual

Fill the histograms for this data element.

Implements VQwDataElement.

Definition at line 144 of file QwHaloMonitor.cc.

References fHalo_Counter, and VQwDataElement::GetElementName().

{
  if (GetElementName()==""){
    //  This channel is not used, so skip filling the histograms.
  }
  else{
    fHalo_Counter.FillHistograms();
  }
}

Here is the call graph for this function:

void QwHaloMonitor::FillTreeVector

(

std::vector< Double_t > &

values

)

const

Definition at line 200 of file QwHaloMonitor.cc.

References fHalo_Counter, and VQwDataElement::GetElementName().

{
  if (GetElementName()==""){
    //  This channel is not used, so skip filling the histograms.
  }
  else{
    fHalo_Counter.FillTreeVector(values);
    // this functions doesn't do anything yet
  }
}

Here is the call graph for this function:

std::vector< QwDBInterface > QwHaloMonitor::GetDBEntry

(

)

Definition at line 212 of file QwHaloMonitor.cc.

References fHalo_Counter.

{
  std::vector <QwDBInterface> row_list;
  row_list.clear();
  fHalo_Counter.AddEntriesToList(row_list);
  return row_list;
}

std::vector< QwErrDBInterface > QwHaloMonitor::GetErrDBEntry

(

)

Definition at line 221 of file QwHaloMonitor.cc.

References fHalo_Counter.

{
  std::vector <QwErrDBInterface> row_list;
  row_list.clear();
  fHalo_Counter.AddErrEntriesToList(row_list);
  return row_list;
}

UInt_t QwHaloMonitor::GetEventcutErrorFlag ( )

inlinevirtual

return the error flag on this channel/device

Reimplemented from VQwDataElement.

Definition at line 87 of file QwHaloMonitor.h.

References fHalo_Counter.

Referenced by UpdateErrorFlag().

{return fHalo_Counter.GetEventcutErrorFlag();};

Here is the caller graph for this function:

std::string QwHaloMonitor::GetExternalClockName ( )

inlinevirtual

Reimplemented from VQwDataElement.

Definition at line 56 of file QwHaloMonitor.h.

References fHalo_Counter.

{ return fHalo_Counter.GetExternalClockName(); };

Double_t QwHaloMonitor::GetNormClockValue ( )

inlinevirtual

Reimplemented from VQwDataElement.

Definition at line 60 of file QwHaloMonitor.h.

References fHalo_Counter.

{ return fHalo_Counter.GetNormClockValue();}

VQwHardwareChannel* QwHaloMonitor::GetScaler ( )

inline

Definition at line 112 of file QwHaloMonitor.h.

References fHalo_Counter.

Referenced by GetScaler().

                                 {
    return &fHalo_Counter;
  };

Here is the caller graph for this function:

const VQwHardwareChannel* QwHaloMonitor::GetScaler ( ) const

inline

Definition at line 116 of file QwHaloMonitor.h.

References GetScaler().

                                             {
    return const_cast<QwHaloMonitor*>(this)->GetScaler();
  };

Here is the call graph for this function:

Double_t QwHaloMonitor::GetValue ( )

inline

Definition at line 120 of file QwHaloMonitor.h.

References fHalo_Counter.

                      {
    return fHalo_Counter.GetValue();
  }

void QwHaloMonitor::IncrementErrorCounters ( )

inline

Definition at line 86 of file QwHaloMonitor.h.

References fHalo_Counter.

{fHalo_Counter.IncrementErrorCounters();};

void QwHaloMonitor::InitializeChannel

(

TString

name

)

Definition at line 21 of file QwHaloMonitor.cc.

References fHalo_Counter, and VQwDataElement::SetElementName().

Referenced by QwHaloMonitor().

                                                  {
  fHalo_Counter.InitializeChannel(name);
  SetElementName(name);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void QwHaloMonitor::InitializeChannel	(	TString	subsystem,
		TString	name
	)

Definition at line 16 of file QwHaloMonitor.cc.

References fHalo_Counter, and VQwDataElement::SetElementName().

                                                                     {
  fHalo_Counter.InitializeChannel(name);
  SetElementName(name);
}

Here is the call graph for this function:

void QwHaloMonitor::LoadChannelParameters ( QwParameterFile &  paramfile )

inlinevirtual

Reimplemented from VQwDataElement.

Definition at line 53 of file QwHaloMonitor.h.

References fHalo_Counter.

                                                        {
    fHalo_Counter.LoadChannelParameters(paramfile);
  }

Bool_t QwHaloMonitor::NeedsExternalClock ( )

inlinevirtual

Reimplemented from VQwDataElement.

Definition at line 57 of file QwHaloMonitor.h.

References fHalo_Counter.

{ return fHalo_Counter.NeedsExternalClock(); };

void QwHaloMonitor::Offset

(

Double_t

Offset

)

QwHaloMonitor & QwHaloMonitor::operator+=

(

const QwHaloMonitor &

value

)

Definition at line 70 of file QwHaloMonitor.cc.

References fHalo_Counter, and VQwDataElement::GetElementName().

{
  if (GetElementName()!=""){
    this->fHalo_Counter+=value.fHalo_Counter;
  }
  return *this;
}

Here is the call graph for this function:

QwHaloMonitor & QwHaloMonitor::operator-=

(

const QwHaloMonitor &

value

)

Definition at line 78 of file QwHaloMonitor.cc.

References fHalo_Counter, and VQwDataElement::GetElementName().

{
  if (GetElementName()!=""){
    this->fHalo_Counter-=value.fHalo_Counter;
  }
  return *this;
}

Here is the call graph for this function:

QwHaloMonitor & QwHaloMonitor::operator=

(

const QwHaloMonitor &

value

)

Definition at line 62 of file QwHaloMonitor.cc.

References fHalo_Counter, and VQwDataElement::GetElementName().

{
  if (GetElementName()!=""){
    this->fHalo_Counter=value.fHalo_Counter;
  }
  return *this;
}

Here is the call graph for this function:

void QwHaloMonitor::PrintErrorCounters

(

)

void QwHaloMonitor::PrintErrorCounters ( ) const

virtual

report number of events failed due to HW and event cut failure

Reimplemented from VQwDataElement.

Definition at line 56 of file QwHaloMonitor.cc.

References fHalo_Counter.

{
  fHalo_Counter.PrintErrorCounters();
}

void QwHaloMonitor::PrintInfo ( ) const

virtual

Print multiple lines of information about this data element.

Reimplemented from VQwDataElement.

Definition at line 128 of file QwHaloMonitor.cc.

References fHalo_Counter.

{
  std::cout << "QwVQWK_Channel Info " << std::endl;
  fHalo_Counter.PrintInfo();
}

void QwHaloMonitor::PrintValue ( ) const

virtual

Print single line of value and error of this data element.

Reimplemented from VQwDataElement.

Definition at line 123 of file QwHaloMonitor.cc.

References fHalo_Counter.

{
  fHalo_Counter.PrintValue();
}

Int_t QwHaloMonitor::ProcessEvBuffer ( UInt_t *  buffer, UInt_t  num_words_left, UInt_t  subelement = 0  )

virtual

Process the CODA event buffer for this element.

Implements VQwDataElement.

Definition at line 37 of file QwHaloMonitor.cc.

References fHalo_Counter.

{
  return fHalo_Counter.ProcessEvBuffer(buffer,num_words_left);
}

void QwHaloMonitor::ProcessEvent

(

)

Definition at line 31 of file QwHaloMonitor.cc.

References fHalo_Counter.

{
  // no processing required for the halos as they are just counters(?).
  fHalo_Counter.ProcessEvent();
}

void QwHaloMonitor::Ratio	(	QwHaloMonitor &	numer,
		QwHaloMonitor &	denom
	)

Definition at line 97 of file QwHaloMonitor.cc.

References fHalo_Counter, and VQwDataElement::GetElementName().

{
  if (GetElementName()!=""){
      this->fHalo_Counter.Ratio(numer.fHalo_Counter,denom.fHalo_Counter);
  }
  return;
}

Here is the call graph for this function:

void QwHaloMonitor::Scale

(

Double_t

Offset

)

Definition at line 105 of file QwHaloMonitor.cc.

References fHalo_Counter.

{
  fHalo_Counter.Scale(factor);
}

void QwHaloMonitor::SetCalibrationFactor ( Double_t  factor )

inline

Definition at line 80 of file QwHaloMonitor.h.

References fHalo_Counter.

{ fHalo_Counter.SetCalibrationFactor(factor); };

void QwHaloMonitor::SetEventCutMode ( Int_t  bcuts )

inline

Definition at line 99 of file QwHaloMonitor.h.

References fHalo_Counter.

                                   {
    fHalo_Counter.SetEventCutMode(bcuts);
  }

void QwHaloMonitor::SetExternalClockName ( const std::string  name )

inlinevirtual

Reimplemented from VQwDataElement.

Definition at line 59 of file QwHaloMonitor.h.

References fHalo_Counter.

{ fHalo_Counter.SetExternalClockName(name);};

void QwHaloMonitor::SetExternalClockPtr ( const VQwHardwareChannel *  clock )

inlinevirtual

Reimplemented from VQwDataElement.

Definition at line 58 of file QwHaloMonitor.h.

References fHalo_Counter.

{fHalo_Counter.SetExternalClockPtr(clock);};

void QwHaloMonitor::SetPedestal ( Double_t  ped )

inline

Definition at line 79 of file QwHaloMonitor.h.

References fHalo_Counter.

{ fHalo_Counter.SetPedestal(ped); };

void QwHaloMonitor::SetSingleEventCuts ( UInt_t  errorflag, Double_t  min, Double_t  max, Double_t  stability  )

inlinevirtual

set the upper and lower limits (fULimit and fLLimit), stability % and the error flag on this channel

Reimplemented from VQwDataElement.

Definition at line 96 of file QwHaloMonitor.h.

References fHalo_Counter.

                                                                                          {
    fHalo_Counter.SetSingleEventCuts(errorflag,min,max,stability);
  };

void QwHaloMonitor::Sum	(	QwHaloMonitor &	value1,
		QwHaloMonitor &	value2
	)

Definition at line 87 of file QwHaloMonitor.cc.

                                                                   {
  *this =  value1;
  *this += value2;
}

UInt_t QwHaloMonitor::UpdateErrorFlag ( )

inlinevirtual

Update the error flag based on the error flags of internally contained objects Return paramter is the "Eventcut Error Flag".

Reimplemented from VQwDataElement.

Definition at line 89 of file QwHaloMonitor.h.

References GetEventcutErrorFlag().

{return GetEventcutErrorFlag();};

Here is the call graph for this function:

void QwHaloMonitor::UpdateErrorFlag ( const QwHaloMonitor *  ev_error )

inline

Definition at line 90 of file QwHaloMonitor.h.

References fHalo_Counter.

                                                     {
    fHalo_Counter.UpdateErrorFlag(ev_error->fHalo_Counter);
  };

void QwHaloMonitor::UpdateHWErrorCount

(

)

Field Documentation

Bool_t QwHaloMonitor::bEVENTCUTMODE

private

Definition at line 138 of file QwHaloMonitor.h.

Int_t QwHaloMonitor::fDeviceErrorCode

private

Definition at line 137 of file QwHaloMonitor.h.

QwSIS3801D24_Channel QwHaloMonitor::fHalo_Counter

private

Definition at line 135 of file QwHaloMonitor.h.

Referenced by AccumulateRunningSum(), ApplySingleEventCuts(), CalculateRunningAverage(), ClearEventData(), ConstructBranch(), ConstructBranchAndVector(), ConstructHistograms(), FillHistograms(), FillTreeVector(), GetDBEntry(), GetErrDBEntry(), GetEventcutErrorFlag(), GetExternalClockName(), GetNormClockValue(), GetScaler(), GetValue(), IncrementErrorCounters(), InitializeChannel(), LoadChannelParameters(), NeedsExternalClock(), operator+=(), operator-=(), operator=(), PrintErrorCounters(), PrintInfo(), PrintValue(), ProcessEvBuffer(), ProcessEvent(), Ratio(), Scale(), SetCalibrationFactor(), SetEventCutMode(), SetExternalClockName(), SetExternalClockPtr(), SetPedestal(), SetSingleEventCuts(), and UpdateErrorFlag().

const Bool_t QwHaloMonitor::kDEBUG

staticprivate

Definition at line 133 of file QwHaloMonitor.h.

---

The documentation for this class was generated from the following files:

• QwHaloMonitor.h
• QwHaloMonitor.cc