cscdqm::Dispatcher Class Reference

CSCDQM Framework frontend and Histogram Cache controller. More...

#include <CSCDQM_Dispatcher.h>

Public Member Functions
void	book ()
	Dispatcher (Configuration *const p_config, MonitorObjectProvider *const p_provider)
	Constructor. More...
const bool	getHisto (const HistoDef &histoD, MonitorObject *&me)
	Global get MO function. If request has reached this function it means that histo is not in cache! More...
void	init ()
	Initialize Dispatcher: book histograms, init processor, etc. More...
unsigned int	maskHWElements (std::vector< std::string > &tokens)
	Mask HW elements from the efficiency calculations. Can be applied on runtime! More...
void	processStandby (HWStandbyType &standby)
	Set HW Standby modes. More...
void	updateFractionAndEfficiencyHistos ()
	On demand update fraction and efficiency MOs. More...
	~Dispatcher ()
	Destructor. Joins and waits to complete all threads. More...

Private Member Functions
void	commonConstruct (Configuration *const p_config, MonitorObjectProvider *const p_provider)
void	updateFractionAndEfficiencyHistosAuto ()
	Automatically called fraction and efficiency MOs update function. More...

Private Attributes
Cache	cache
Collection	collection
Configuration *	config
EventProcessor	processor
EventProcessorMutex	processorFract
MonitorObjectProvider *	provider

Detailed Description

CSCDQM Framework frontend and Histogram Cache controller.

Definition at line 122 of file CSCDQM_Dispatcher.h.

Constructor & Destructor Documentation

cscdqm::Dispatcher::Dispatcher	(	Configuration *const	p_config,
		MonitorObjectProvider *const	p_provider
	)

Constructor.

Parameters

p_config	Pointer to Global Configuration
p_provider	Pointer to MonitorObjectProvider

Returns

Definition at line 29 of file CSCDQM_Dispatcher.cc.

References commonConstruct().

                                                                                       :
    collection(p_config), processor(p_config), processorFract(p_config) {
  commonConstruct( p_config, p_provider );
}

cscdqm::Dispatcher::~Dispatcher ( )

inline

Destructor. Joins and waits to complete all threads.

Definition at line 136 of file CSCDQM_Dispatcher.h.

                    { 
#ifdef DQMMT      
        threads.join_all(); 
#endif      
      }

Member Function Documentation

void cscdqm::Dispatcher::book

(

)

For the first FED - book general

For the first DDU - book general

For the first and specific CSCs - book general and specific

No DMB in slot 6

For the Parameters - book parameter histograms

Definition at line 91 of file CSCDQM_Dispatcher.cc.

References cscdqm::Collection::bookCSCHistos(), cscdqm::Collection::bookDDUHistos(), cscdqm::Collection::bookEMUHistos(), cscdqm::Collection::bookFEDHistos(), cscdqm::MonitorObjectProvider::bookMonitorObject(), cache, collection, config, i, cscdqm::EventProcessor::init(), cscdqm::Cache::isBookedCSC(), cscdqm::Cache::isBookedDDU(), cscdqm::Cache::isBookedFED(), cscdqm::h::PAR_CSC_SIDEMINUS, cscdqm::h::PAR_CSC_SIDEMINUS_STATION01, cscdqm::h::PAR_CSC_SIDEMINUS_STATION01_RING01, cscdqm::h::PAR_CSC_SIDEMINUS_STATION01_RING02, cscdqm::h::PAR_CSC_SIDEMINUS_STATION01_RING03, cscdqm::h::PAR_CSC_SIDEMINUS_STATION02, cscdqm::h::PAR_CSC_SIDEMINUS_STATION02_RING01, cscdqm::h::PAR_CSC_SIDEMINUS_STATION02_RING02, cscdqm::h::PAR_CSC_SIDEMINUS_STATION03, cscdqm::h::PAR_CSC_SIDEMINUS_STATION03_RING01, cscdqm::h::PAR_CSC_SIDEMINUS_STATION03_RING02, cscdqm::h::PAR_CSC_SIDEMINUS_STATION04, cscdqm::h::PAR_CSC_SIDEMINUS_STATION04_RING01, cscdqm::h::PAR_CSC_SIDEMINUS_STATION04_RING02, cscdqm::h::PAR_CSC_SIDEPLUS, cscdqm::h::PAR_CSC_SIDEPLUS_STATION01, cscdqm::h::PAR_CSC_SIDEPLUS_STATION01_RING01, cscdqm::h::PAR_CSC_SIDEPLUS_STATION01_RING02, cscdqm::h::PAR_CSC_SIDEPLUS_STATION01_RING03, cscdqm::h::PAR_CSC_SIDEPLUS_STATION02, cscdqm::h::PAR_CSC_SIDEPLUS_STATION02_RING01, cscdqm::h::PAR_CSC_SIDEPLUS_STATION02_RING02, cscdqm::h::PAR_CSC_SIDEPLUS_STATION03, cscdqm::h::PAR_CSC_SIDEPLUS_STATION03_RING01, cscdqm::h::PAR_CSC_SIDEPLUS_STATION03_RING02, cscdqm::h::PAR_CSC_SIDEPLUS_STATION04, cscdqm::h::PAR_CSC_SIDEPLUS_STATION04_RING01, cscdqm::h::PAR_CSC_SIDEPLUS_STATION04_RING02, cscdqm::h::PAR_REPORT_SUMMARY, Parameters::parameters, processor, provider, and cscdqm::Cache::put().

Referenced by CSCMonitorModule::bookHistograms(), and CSCOfflineClient::dqmEndJob().

                      {

  collection.bookEMUHistos();

  /*** FOr multi-threading pre-book all FED, DDU, CSC histograms ***/
  if ( config->getPREBOOK_ALL_HISTOS()) {

    for (HwId FEDId = 750; FEDId < 758; FEDId++) {
      if (!cache.isBookedFED(FEDId)) {
        collection.bookFEDHistos(FEDId);
      }
    }

    if (config->getPROCESS_DDU()) {
      for (HwId DDUId = 1; DDUId <= 36; DDUId++) {
        if (!cache.isBookedDDU(DDUId)) {
          collection.bookDDUHistos(DDUId);
        }
      }
    }

    if (config->getPROCESS_CSC()) {
      for (HwId CrateId = 1; CrateId <= 60; CrateId++) {
        for (HwId DMBId = 1; DMBId <=10; DMBId++) {
          if (DMBId == 6) continue; 
          if (!cache.isBookedCSC(CrateId, DMBId)) {
            collection.bookCSCHistos(CrateId, DMBId);
          }
        }
      }
    }

    if (config->getPROCESS_EFF_PARAMETERS()) {
      std::vector<HistoId> parameters;
      parameters.push_back(h::PAR_CSC_SIDEPLUS_STATION01_RING01);
      parameters.push_back(h::PAR_CSC_SIDEPLUS_STATION01_RING02);
      parameters.push_back(h::PAR_CSC_SIDEPLUS_STATION01_RING03);
      parameters.push_back(h::PAR_CSC_SIDEPLUS_STATION01);
      parameters.push_back(h::PAR_CSC_SIDEPLUS_STATION02_RING01);
      parameters.push_back(h::PAR_CSC_SIDEPLUS_STATION02_RING02);
      parameters.push_back(h::PAR_CSC_SIDEPLUS_STATION02);
      parameters.push_back(h::PAR_CSC_SIDEPLUS_STATION03_RING01);
      parameters.push_back(h::PAR_CSC_SIDEPLUS_STATION03_RING02);
      parameters.push_back(h::PAR_CSC_SIDEPLUS_STATION03);
      parameters.push_back(h::PAR_CSC_SIDEPLUS_STATION04_RING01);
      parameters.push_back(h::PAR_CSC_SIDEPLUS_STATION04_RING02);
      parameters.push_back(h::PAR_CSC_SIDEPLUS_STATION04);
      parameters.push_back(h::PAR_CSC_SIDEPLUS);
      parameters.push_back(h::PAR_CSC_SIDEMINUS_STATION01_RING01);
      parameters.push_back(h::PAR_CSC_SIDEMINUS_STATION01_RING02);
      parameters.push_back(h::PAR_CSC_SIDEMINUS_STATION01_RING03);
      parameters.push_back(h::PAR_CSC_SIDEMINUS_STATION01);
      parameters.push_back(h::PAR_CSC_SIDEMINUS_STATION02_RING01);
      parameters.push_back(h::PAR_CSC_SIDEMINUS_STATION02_RING02);
      parameters.push_back(h::PAR_CSC_SIDEMINUS_STATION02);
      parameters.push_back(h::PAR_CSC_SIDEMINUS_STATION03_RING01);
      parameters.push_back(h::PAR_CSC_SIDEMINUS_STATION03_RING02);
      parameters.push_back(h::PAR_CSC_SIDEMINUS_STATION03);
      parameters.push_back(h::PAR_CSC_SIDEMINUS_STATION04_RING01);
      parameters.push_back(h::PAR_CSC_SIDEMINUS_STATION04_RING02);
      parameters.push_back(h::PAR_CSC_SIDEMINUS_STATION04);
      parameters.push_back(h::PAR_CSC_SIDEMINUS);
      parameters.push_back(h::PAR_REPORT_SUMMARY);


      for (size_t i = 0; i < parameters.size(); i++) {
        ParHistoDef histoD(parameters[i]);
        HistoBookRequest req(parameters[i], config->getFOLDER_PAR(), -1.0f);
        MonitorObject* me = provider->bookMonitorObject(req);
        cache.put(histoD, me);
      }
    }

  }

  processor.init();

}

void cscdqm::Dispatcher::commonConstruct ( Configuration *const  p_config, MonitorObjectProvider *const  p_provider  )

private

Save pointers to class properties

Link/share Cache methods to function pointers in configuration

Link/share local functions

Link/share getCSCDetId function

Link/share booking function

Definition at line 52 of file CSCDQM_Dispatcher.cc.

References cscdqm::MonitorObjectProvider::bookMonitorObject(), cache, config, cscdqm::Configuration::fnBook, cscdqm::Configuration::fnGetCacheCSCHisto, cscdqm::Configuration::fnGetCacheDDUHisto, cscdqm::Configuration::fnGetCacheEMUHisto, cscdqm::Configuration::fnGetCacheFEDHisto, cscdqm::Configuration::fnGetCacheParHisto, cscdqm::Configuration::fnGetCSCDetId, cscdqm::Configuration::fnGetHisto, cscdqm::Configuration::fnIsBookedCSC, cscdqm::Configuration::fnIsBookedDDU, cscdqm::Configuration::fnIsBookedFED, cscdqm::Configuration::fnNextBookedCSC, cscdqm::Configuration::fnPutHisto, cscdqm::Cache::getCSC(), cscdqm::MonitorObjectProvider::getCSCDetId(), cscdqm::Cache::getDDU(), cscdqm::Cache::getEMU(), cscdqm::Cache::getFED(), getHisto(), cscdqm::Cache::getPar(), cscdqm::Cache::isBookedCSC(), cscdqm::Cache::isBookedDDU(), cscdqm::Cache::isBookedFED(), cscdqm::Cache::nextBookedCSC(), provider, and cscdqm::Cache::put().

Referenced by Dispatcher().

                                                                                                   {

  config = p_config;
  provider = p_provider;

  config->fnGetCacheEMUHisto = boost::bind(&Cache::getEMU, &cache, _1, _2);
  config->fnGetCacheFEDHisto = boost::bind(&Cache::getFED, &cache, _1, _2, _3);
  config->fnGetCacheDDUHisto = boost::bind(&Cache::getDDU, &cache, _1, _2, _3);
  config->fnGetCacheCSCHisto = boost::bind(&Cache::getCSC, &cache, _1, _2, _3, _4, _5);
  config->fnGetCacheParHisto = boost::bind(&Cache::getPar, &cache, _1, _2);
  config->fnPutHisto = boost::bind(&Cache::put, &cache, _1, _2);
  config->fnNextBookedCSC = boost::bind(&Cache::nextBookedCSC, &cache, _1, _2, _3);
  config->fnIsBookedCSC = boost::bind(&Cache::isBookedCSC, &cache, _1, _2);
  config->fnIsBookedDDU = boost::bind(&Cache::isBookedDDU, &cache, _1);
  config->fnIsBookedFED = boost::bind(&Cache::isBookedFED, &cache, _1);

  config->fnGetHisto = boost::bind(&Dispatcher::getHisto, this, _1, _2);

  config->fnGetCSCDetId = boost::bind(&MonitorObjectProvider::getCSCDetId, provider, _1, _2, _3);

  config->fnBook = boost::bind(&MonitorObjectProvider::bookMonitorObject, provider, _1);

}

const bool cscdqm::Dispatcher::getHisto	(	const HistoDef &	histoD,
		MonitorObject *&	me
	)

Global get MO function. If request has reached this function it means that histo is not in cache!

Parameters

histoD	Histogram Definition to get
me	MO to return

Returns

true if me found and filled, false - otherwise

For the first FED - book general

For the first DDU - book general

For the first and specific CSCs - book general and specific

cache.printContent();

For the Parameters - book parameter histogram

If not found after booking - mark it as not existent

Definition at line 190 of file CSCDQM_Dispatcher.cc.

References cscdqm::Collection::bookCSCHistos(), cscdqm::Collection::bookDDUHistos(), cscdqm::Collection::bookFEDHistos(), cscdqm::MonitorObjectProvider::bookMonitorObject(), cache, collection, config, cscdqm::CSCHistoDefT, cscdqm::DDUHistoDefT, cscdqm::FEDHistoDefT, cscdqm::Cache::get(), cscdqm::HistoDef::getAddId(), cscdqm::HistoDef::getCrateId(), cscdqm::HistoDef::getDDUId(), cscdqm::HistoDef::getDMBId(), cscdqm::HistoDef::getFEDId(), cscdqm::HistoDef::getHistoName(), cscdqm::HistoDef::getId(), cscdqm::Cache::isBookedCSC(), cscdqm::Cache::isBookedDDU(), cscdqm::Cache::isBookedFED(), cscdqm::Collection::isOnDemand(), NULL, cscdqm::ParHistoDefT, provider, and cscdqm::Cache::put().

Referenced by commonConstruct().

                                                                          {

  if (typeid(histoD) == FEDHistoDefT && !cache.isBookedFED(histoD.getFEDId())) {
    collection.bookFEDHistos(histoD.getFEDId());
    if (cache.get(histoD, me)) return true;
  }

  if (typeid(histoD) == DDUHistoDefT && !cache.isBookedDDU(histoD.getDDUId())) {
    collection.bookDDUHistos(histoD.getDDUId());
    if (cache.get(histoD, me)) return true;
  }

  if (typeid(histoD) == CSCHistoDefT) {
    if (!cache.isBookedCSC(histoD.getCrateId(), histoD.getDMBId())) {
      collection.bookCSCHistos(histoD.getCrateId(), histoD.getDMBId());
    }
    if (collection.isOnDemand(histoD.getHistoName())) {
      collection.bookCSCHistos(histoD.getId(), histoD.getCrateId(), histoD.getDMBId(), histoD.getAddId());
    }
    if (cache.get(histoD, me)) return true;
  }

  if (typeid(histoD) == ParHistoDefT) {
    HistoBookRequest req(histoD, config->getFOLDER_PAR(), -1.0f);
    me = provider->bookMonitorObject(req);
    cache.put(histoD, me);
    return true;
  }

  cache.put(histoD, NULL);

  return false;
}

void cscdqm::Dispatcher::init

(

void

)

Initialize Dispatcher: book histograms, init processor, etc.

Returns

Definition at line 85 of file CSCDQM_Dispatcher.cc.

References collection, and cscdqm::Collection::load().

Referenced by CSCMonitorModule::CSCMonitorModule(), and CSCOfflineClient::CSCOfflineClient().

                      {
  collection.load();
  // collection.bookEMUHistos();
  // processor.init();
}

unsigned int cscdqm::Dispatcher::maskHWElements

(

std::vector< std::string > &

tokens

)

Mask HW elements from the efficiency calculations. Can be applied on runtime!

Parameters

tokens

String tokens of the HW elements

Returns

elements masked

Definition at line 180 of file CSCDQM_Dispatcher.cc.

References cscdqm::EventProcessorMutex::maskHWElements(), and processorFract.

Referenced by CSCMonitorModule::bookHistograms(), and CSCOfflineClient::dqmEndJob().

                                                                    {
  return processorFract.maskHWElements(tokens);
}

void cscdqm::Dispatcher::processStandby

(

HWStandbyType &

standby

)

Set HW Standby modes.

Returns

Definition at line 264 of file CSCDQM_Dispatcher.cc.

References config, CommonMethods::lock(), cscdqm::Lock::mutex, processorFract, and cscdqm::EventProcessorMutex::processStandby().

                                                      {
  LockType lock(processorFract.mutex);
  if (config->getFRAEFF_SEPARATE_THREAD()) {
    boost::function<void (HWStandbyType&)> fnUpdate = boost::bind(&EventProcessorMutex::processStandby, &processorFract, _1);
#ifdef DQMMT
    threads.create_thread(boost::ref(fnUpdate));
#else
    fnUpdate(standby);
#endif
  } else {
    processorFract.processStandby(standby);
  }
}

void cscdqm::Dispatcher::updateFractionAndEfficiencyHistos

(

)

On demand update fraction and efficiency MOs.

Returns

Definition at line 246 of file CSCDQM_Dispatcher.cc.

References config, CommonMethods::lock(), cscdqm::Lock::mutex, processorFract, and cscdqm::EventProcessorMutex::updateFractionAndEfficiencyHistos().

Referenced by CSCMonitorModule::bookHistograms(), CSCOfflineClient::dqmEndJob(), and updateFractionAndEfficiencyHistosAuto().

                                                   {
  LockType lock(processorFract.mutex);
  if (config->getFRAEFF_SEPARATE_THREAD()) {
    boost::function<void ()> fnUpdate = boost::bind(&EventProcessorMutex::updateFractionAndEfficiencyHistos, &processorFract);
#ifdef DQMMT
    threads.create_thread(boost::ref(fnUpdate));
#else
    fnUpdate();
#endif
  } else {
    processorFract.updateFractionAndEfficiencyHistos();
  }
}

void cscdqm::Dispatcher::updateFractionAndEfficiencyHistosAuto ( )

private

Automatically called fraction and efficiency MOs update function.

Returns

Definition at line 234 of file CSCDQM_Dispatcher.cc.

References config, cscdqm::Configuration::getNEventsCSC(), and updateFractionAndEfficiencyHistos().

                                                       {
  if ( config->getFRAEFF_AUTO_UPDATE() &&
       (config->getNEventsCSC() >= config->getFRAEFF_AUTO_UPDATE_START()) &&
       (config->getNEventsCSC() % config->getFRAEFF_AUTO_UPDATE_FREQ()) == 0) {
    updateFractionAndEfficiencyHistos();
  }
}

Member Data Documentation

Cache cscdqm::Dispatcher::cache

private

MO Cache object

Definition at line 169 of file CSCDQM_Dispatcher.h.

Referenced by book(), commonConstruct(), and getHisto().

Collection cscdqm::Dispatcher::collection

private

MO Collection object

Definition at line 163 of file CSCDQM_Dispatcher.h.

Referenced by book(), getHisto(), and init().

Configuration* cscdqm::Dispatcher::config

private

Pointer to Global Configuration

Definition at line 157 of file CSCDQM_Dispatcher.h.

Referenced by book(), commonConstruct(), getHisto(), processStandby(), updateFractionAndEfficiencyHistos(), and updateFractionAndEfficiencyHistosAuto().

EventProcessor cscdqm::Dispatcher::processor

private

Event Processor object

Definition at line 166 of file CSCDQM_Dispatcher.h.

Referenced by book().

EventProcessorMutex cscdqm::Dispatcher::processorFract

private

Lockable Fractional and Efficiency MO update object

Definition at line 172 of file CSCDQM_Dispatcher.h.

Referenced by maskHWElements(), processStandby(), and updateFractionAndEfficiencyHistos().

MonitorObjectProvider* cscdqm::Dispatcher::provider

private

Pointer to MO provider

Definition at line 160 of file CSCDQM_Dispatcher.h.

Referenced by book(), commonConstruct(), and getHisto().