Database object containing the nominal accelerator RF value and the prescales to derive the clock frequencies of the sub-detectors. More...

#include <HardwareClockSettings.h>

Inheritance diagram for HardwareClockSettings:

[legend]

Collaboration diagram for HardwareClockSettings:

[legend]

Public Member Functions
	HardwareClockSettings ()
	Constructor.

double	getClockPrescale (Const::EDetector detector, std::string label) const
	Get the prescale factor used to derive a detector clock from the global clock frequency.

double	getClockFrequency (Const::EDetector detector, std::string label) const
	Get the frequency of a detector clock.

double	getGlobalClockFrequency () const
	Get the global clock (system clock) frequency.

double	getAcceleratorRF () const
	Get the accelerator RF value.

void	setClockPrescale (const Const::EDetector detector, std::string label, double prescale)
	Set the prescale value used to derive a detector clock from the global clock frequency.

void	setClockFrequency (const Const::EDetector detector, std::string label, double frequency)
	Set the frequency value of detector clock not derived from the global clock.

void	setAcceleratorRF (double acceleratorRF)
	Set the accelerator RF value.

bool	isPrescaleAvailable (Const::EDetector detector, std::string label) const
	Check if the prescale of a clock is available.

bool	isFrequencyAvailable (Const::EDetector detector, std::string label) const
	Check if the frequency of a detector clock is available.

void	print () const
	Print the content of the class.

Private Attributes
std::map< Const::EDetector, std::map< std::string, double > >	m_prescaleMap
	Map of prescale factors used to derive the clock frequencies from the global clock frequency.

std::map< Const::EDetector, std::map< std::string, double > >	m_clocksMap
	Map of clock frequencies not derived from the global clock frequency.

double	m_acceleratorRF = 0
	Accelerator radio frequency [GHz].

Detailed Description

Database object containing the nominal accelerator RF value and the prescales to derive the clock frequencies of the sub-detectors.

Global clock frequency (system clock) is RF/4.

Definition at line 25 of file HardwareClockSettings.h.

Constructor & Destructor Documentation

◆ HardwareClockSettings()

HardwareClockSettings ( )

Constructor.

Definition at line 15 of file HardwareClockSettings.cc.

15{}

Member Function Documentation

◆ getAcceleratorRF()

double getAcceleratorRF ( ) const

Get the accelerator RF value.

Returns: frequency [GHz]

Definition at line 57 of file HardwareClockSettings.cc.

{
  return  m_acceleratorRF;
}

◆ getClockFrequency()

double getClockFrequency	(	Const::EDetector	detector,
		std::string	label
	)		const

Get the frequency of a detector clock.

Parameters

detector	The ID of the detector.
label	The label for the clock.

Returns: frequency [GHz]

Definition at line 34 of file HardwareClockSettings.cc.

{
  bool isDetectorInPrescaleMap = true;
 
  if (m_prescaleMap.find(detector) == m_prescaleMap.end()) isDetectorInPrescaleMap = false;
  else if (m_prescaleMap.at(detector).find(label) != m_prescaleMap.at(detector).end())
    return  m_acceleratorRF / 4. / m_prescaleMap.at(detector).at(label);
 
  if (m_clocksMap.find(detector) == m_clocksMap.end()) {
    if (!isDetectorInPrescaleMap) B2ERROR("No clocks available for " << Const::parseDetectors(detector));
    else  B2ERROR("Clock named " << label << " not available for " << Const::parseDetectors(detector));
  } else if (m_clocksMap.at(detector).find(label) != m_clocksMap.at(detector).end())
    return  m_clocksMap.at(detector).at(label);
  else B2ERROR("Clock named " << label << " not available for " << Const::parseDetectors(detector));
 
  return std::numeric_limits<double>::quiet_NaN();
}

◆ getClockPrescale()

double getClockPrescale	(	Const::EDetector	detector,
		std::string	label
	)		const

Get the prescale factor used to derive a detector clock from the global clock frequency.

Parameters

detector	The ID of the detector.
label	The label for the clock.

Returns: prescale factor

Definition at line 62 of file HardwareClockSettings.cc.

{
  if (m_prescaleMap.find(detector) == m_prescaleMap.end()) B2ERROR("No clocks available for " << Const::parseDetectors(detector));
  else if (m_prescaleMap.at(detector).find(label) != m_prescaleMap.at(detector).end())
    return m_prescaleMap.at(detector).at(label);
  else B2ERROR("Clock named " << label << " not available for " << Const::parseDetectors(detector));
 
  return std::numeric_limits<double>::quiet_NaN();
}

◆ getGlobalClockFrequency()

double getGlobalClockFrequency ( ) const

Get the global clock (system clock) frequency.

Returns: frequency [GHz]

Definition at line 52 of file HardwareClockSettings.cc.

{
  return  m_acceleratorRF / 4.;
}

◆ isFrequencyAvailable()

bool isFrequencyAvailable	(	Const::EDetector	detector,
		std::string	label
	)		const

Check if the frequency of a detector clock is available.

The check is performed for both the clocks derived from the globalclock and the clocks not derived from it.

Parameters

detector	The ID of the detector.
label	The label for the clock.

Returns: true, if available

Definition at line 25 of file HardwareClockSettings.cc.

{
  if (((m_prescaleMap.find(detector) == m_prescaleMap.end()) or
       (m_prescaleMap.at(detector).find(label) == m_prescaleMap.at(detector).end()))
      and ((m_clocksMap.find(detector) == m_clocksMap.end()) or
           (m_clocksMap.at(detector).find(label) == m_clocksMap.at(detector).end()))) return false;
  else return true;
}

◆ isPrescaleAvailable()

bool isPrescaleAvailable	(	Const::EDetector	detector,
		std::string	label
	)		const

Check if the prescale of a clock is available.

Parameters

detector	The ID of the detector.
label	The label for the clock.

Returns: true, if available

Definition at line 18 of file HardwareClockSettings.cc.

{
  if ((m_prescaleMap.find(detector) == m_prescaleMap.end())
      or (m_prescaleMap.at(detector).find(label) == m_prescaleMap.at(detector).end())) return false;
  else return true;
}

◆ print()

void print ( ) const

Print the content of the class.

Definition at line 88 of file HardwareClockSettings.cc.

{
  std::cout << std::endl;
  std::cout << "Accelerator RF: " << m_acceleratorRF / Unit::MHz << " MHz" << std::endl;
  std::cout << "Clock prescale factors:" << std::endl;
  std::cout << "===================================" << std::endl;
 
  for (const auto& det : m_prescaleMap) {
    std::cout << Const::parseDetectors(det.first) << ":" << std::endl;
    for (const auto& clock : det.second)  std::cout << " " << clock.first << " " << clock.second << std::endl;
  }
  std::cout << "===================================" << std::endl;
 
  std::cout << "Clock frequencies:" << std::endl;
  std::cout << "===================================" << std::endl;
  for (const auto& det : m_clocksMap) {
    std::cout << Const::parseDetectors(det.first) << ":" << std::endl;
    for (const auto& clock : det.second) {
      std::cout << " " << clock.first << " " << clock.second / Unit::MHz << " MHz" << std::endl;
    }
  }
  std::cout << "===================================" << std::endl;
}

◆ setAcceleratorRF()

void setAcceleratorRF ( double acceleratorRF )

Set the accelerator RF value.

Parameters

acceleratorRF Accelerator RF value [GHz].

Definition at line 83 of file HardwareClockSettings.cc.

{
  m_acceleratorRF = acceleratorRF;
}

◆ setClockFrequency()

void setClockFrequency	(	const Const::EDetector	detector,
		std::string	label,
		double	frequency
	)

Set the frequency value of detector clock not derived from the global clock.

Parameters

detector	The ID of the detector.
label	The label for the clock.
frequency	The frequency for the clock [GHz]

Definition at line 78 of file HardwareClockSettings.cc.

{
  m_clocksMap[detector][label] = frequency;
}

◆ setClockPrescale()

void setClockPrescale	(	const Const::EDetector	detector,
		std::string	label,
		double	prescale
	)

Set the prescale value used to derive a detector clock from the global clock frequency.

Parameters

detector	The ID of the detector.
label	The label for the clock.
prescale	The prescale factor of the clock.

Definition at line 72 of file HardwareClockSettings.cc.

{
  m_prescaleMap[detector][label] = prescale;
}

Member Data Documentation

◆ m_acceleratorRF

double m_acceleratorRF = 0

private

Accelerator radio frequency [GHz].

Definition at line 119 of file HardwareClockSettings.h.

◆ m_clocksMap

std::map<Const::EDetector, std::map<std::string, double> > m_clocksMap

private

Map of clock frequencies not derived from the global clock frequency.

Clock frequency units are GHz.

Definition at line 114 of file HardwareClockSettings.h.

◆ m_prescaleMap

std::map<Const::EDetector, std::map<std::string, double> > m_prescaleMap

private

Map of prescale factors used to derive the clock frequencies from the global clock frequency.

Definition at line 108 of file HardwareClockSettings.h.

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

framework/dbobjects/include/HardwareClockSettings.h
framework/dbobjects/src/HardwareClockSettings.cc

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ HardwareClockSettings()

Member Function Documentation

◆ getAcceleratorRF()

◆ getClockFrequency()

◆ getClockPrescale()

◆ getGlobalClockFrequency()

◆ isFrequencyAvailable()

◆ isPrescaleAvailable()

◆ print()

◆ setAcceleratorRF()

◆ setClockFrequency()

◆ setClockPrescale()

Member Data Documentation

◆ m_acceleratorRF

◆ m_clocksMap

◆ m_prescaleMap