TOPCalIntegratedCharge Class Reference

Class to store integrated charge per channel. More...

#include <TOPCalIntegratedCharge.h>

Inheritance diagram for TOPCalIntegratedCharge:

Public Types
enum	EStatus {   c_Default = 0 ,   c_Calibrated = 1 ,   c_Unusable = 2 }
	Calibration status of a constant. More...

Public Member Functions
	TOPCalIntegratedCharge ()
	Default constructor.
void	setCharge (int moduleID, unsigned channel, double charge)
	Sets the integrated charge for a single channel and switches status to calibrated.
void	setUnusable (int moduleID, unsigned channel)
	Switches calibration status to unusable to flag badly calibrated constant.
double	getCharge (int moduleID, unsigned channel) const
	Returns the integrated charge of a single channel.
bool	isCalibrated (int moduleID, unsigned channel) const
	Returns calibration status.
bool	isDefault (int moduleID, unsigned channel) const
	Returns calibration status.
bool	isUnusable (int moduleID, unsigned channel) const
	Returns calibration status.

Private Types
enum	{   c_numModules = 16 ,   c_numChannels = 512 }
	Sizes. More...

Private Member Functions
	ClassDef (TOPCalIntegratedCharge, 1)
	ClassDef.

Private Attributes
float	m_charge [c_numModules][c_numChannels] = {{0}}
	integrated charge [C/cm^2]
EStatus	m_status [c_numModules][c_numChannels] = {{c_Default}}
	calibration status

Detailed Description

Class to store integrated charge per channel.

Definition at line 23 of file TOPCalIntegratedCharge.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Sizes.

Enumerator
c_numModules	number of modules
c_numChannels	number of channels per module

Definition at line 147 of file TOPCalIntegratedCharge.h.

         {
      c_numModules = 16,  
      c_numChannels = 512 
    };

EStatus

enum EStatus

Calibration status of a constant.

Enumerator
c_Default	uncalibrated default value
c_Calibrated	good calibrated value
c_Unusable	bad calibrated value

Definition at line 29 of file TOPCalIntegratedCharge.h.

                 {
      c_Default = 0,    
      c_Calibrated = 1, 
      c_Unusable = 2    
    };

Constructor & Destructor Documentation

TOPCalIntegratedCharge()

TOPCalIntegratedCharge ( )

inline

Default constructor.

Definition at line 38 of file TOPCalIntegratedCharge.h.

{}

Member Function Documentation

getCharge()

double getCharge ( int  moduleID, unsigned  channel  ) const

inline

Returns the integrated charge of a single channel.

Parameters

moduleID	module ID (1-based)
channel	hardware channel number (0-based)

Returns

integrated charge [C/cm^2]

Definition at line 86 of file TOPCalIntegratedCharge.h.

    {
      unsigned module = moduleID - 1;
      if (module >= c_numModules) {
        B2WARNING("Invalid module number, returning 0 (" << ClassName() << ")");
        return 0;
      }
      if (channel >= c_numChannels) {
        B2WARNING("Invalid channel number, returning 0 (" << ClassName() << ")");
        return 0;
      }
      return m_charge[module][channel];
    }

isCalibrated()

bool isCalibrated ( int  moduleID, unsigned  channel  ) const

inline

Returns calibration status.

Parameters

moduleID	module ID (1-based)
channel	hardware channel number (0-based)

Returns

true, if good calibrated

Definition at line 106 of file TOPCalIntegratedCharge.h.

    {
      unsigned module = moduleID - 1;
      if (module >= c_numModules) return false;
      if (channel >= c_numChannels) return false;
      return m_status[module][channel] == c_Calibrated;
    }

isDefault()

bool isDefault ( int  moduleID, unsigned  channel  ) const

inline

Returns calibration status.

Parameters

moduleID	module ID (1-based)
channel	hardware channel number (0-based)

Returns

true, if default (not calibrated)

Definition at line 120 of file TOPCalIntegratedCharge.h.

    {
      unsigned module = moduleID - 1;
      if (module >= c_numModules) return false;
      if (channel >= c_numChannels) return false;
      return m_status[module][channel] == c_Default;
    }

isUnusable()

bool isUnusable ( int  moduleID, unsigned  channel  ) const

inline

Returns calibration status.

Parameters

moduleID	module ID (1-based)
channel	hardware channel number (0-based)

Returns

true, if bad calibrated

Definition at line 134 of file TOPCalIntegratedCharge.h.

    {
      unsigned module = moduleID - 1;
      if (module >= c_numModules) return false;
      if (channel >= c_numChannels) return false;
      return m_status[module][channel] == c_Unusable;
    }

setCharge()

void setCharge ( int  moduleID, unsigned  channel, double  charge  )

inline

Sets the integrated charge for a single channel and switches status to calibrated.

Parameters

moduleID	module ID (1-based)
channel	hardware channel number (0-based)
charge	integrated charge in Coulombs per cm^2

Definition at line 46 of file TOPCalIntegratedCharge.h.

    {
      unsigned module = moduleID - 1;
      if (module >= c_numModules) {
        B2ERROR("Invalid module number, constant not set (" << ClassName() << ")");
        return;
      }
      if (channel >= c_numChannels) {
        B2ERROR("Invalid channel number, constant not set (" << ClassName() << ")");
        return;
      }
      m_charge[module][channel] = charge;
      m_status[module][channel] = c_Calibrated;
    }

setUnusable()

void setUnusable ( int  moduleID, unsigned  channel  )

inline

Switches calibration status to unusable to flag badly calibrated constant.

Parameters

moduleID	module ID (1-based)
channel	hardware channel number (0-based)

Definition at line 66 of file TOPCalIntegratedCharge.h.

    {
      unsigned module = moduleID - 1;
      if (module >= c_numModules) {
        B2ERROR("Invalid module number, status not set (" << ClassName() << ")");
        return;
      }
      if (channel >= c_numChannels) {
        B2ERROR("Invalid channel number, status not set (" << ClassName() << ")");
        return;
      }
      m_status[module][channel] = c_Unusable;
    }

Member Data Documentation

m_charge

float m_charge[c_numModules][c_numChannels] = {{0}}

private

integrated charge [C/cm^2]

Definition at line 152 of file TOPCalIntegratedCharge.h.

m_status

EStatus m_status[c_numModules][c_numChannels] = {{c_Default}}

private

calibration status

Definition at line 153 of file TOPCalIntegratedCharge.h.

---

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

• top/dbobjects/include/TOPCalIntegratedCharge.h