edm::ConfigurationDescriptions Class Reference

#include <ConfigurationDescriptions.h>

Classes
class	DescriptionCounter

Public Member Functions
void	add (std::string const &label, ParameterSetDescription const &psetDescription)
void	add (char const *label, ParameterSetDescription const &psetDescription)
void	addDefault (ParameterSetDescription const &psetDescription)
std::string const &	comment () const
	ConfigurationDescriptions (std::string const &baseType)
void	print (std::ostream &os, std::string const &moduleLabel, bool brief, bool printOnlyLabels, size_t lineWidth, int indentation, int iPlugin) const
void	setComment (std::string const &value)
void	setComment (char const *value)
void	validate (ParameterSet &pset, std::string const &moduleLabel) const
void	writeCfis (std::string const &baseType, std::string const &pluginName) const
	~ConfigurationDescriptions ()

Private Member Functions
void	printForLabel (std::pair< std::string, ParameterSetDescription > const &labelAndDesc, std::ostream &os, std::string const &moduleLabel, bool brief, bool printOnlyLabels, size_t lineWidth, int indentationn, DescriptionCounter &counter) const
void	printForLabel (std::ostream &os, std::string const &label, ParameterSetDescription const &description, std::string const &moduleLabel, bool brief, bool printOnlyLabels, size_t lineWidth, int indentationn, DescriptionCounter &counter) const

Static Private Member Functions
static void	writeCfiForLabel (std::pair< std::string, ParameterSetDescription > const &labelAndDesc, std::string const &baseType, std::string const &pluginName)

Private Attributes
std::string	baseType_
std::string	comment_
ParameterSetDescription	defaultDesc_
bool	defaultDescDefined_
std::vector< std::pair < std::string, ParameterSetDescription > >	descriptions_

Detailed Description

Definition at line 27 of file ConfigurationDescriptions.h.

Constructor & Destructor Documentation

ConfigurationDescriptions::ConfigurationDescriptions

(

std::string const &

baseType

)

Definition at line 37 of file ConfigurationDescriptions.cc.

                                                                                :
    baseType_(baseType),
    defaultDescDefined_(false)
  { }

ConfigurationDescriptions::~ConfigurationDescriptions

(

)

Definition at line 42 of file ConfigurationDescriptions.cc.

{} 

Member Function Documentation

void ConfigurationDescriptions::add	(	std::string const &	label,
		ParameterSetDescription const &	psetDescription
	)

Definition at line 60 of file ConfigurationDescriptions.cc.

References baseType_, defaultDescDefined_, descriptions_, edm::hlt::Exception, label, edm::errors::LogicError, and mergeVDriftHistosByStation::name.

Referenced by add(), edm::EmptySource::fillDescriptions(), edm::Prescaler::fillDescriptions(), edm::service::InitRootHandlers::fillDescriptions(), edm::EventAuxiliaryHistoryProducer::fillDescriptions(), HLTHPDFilter::fillDescriptions(), TFileAdaptor::fillDescriptions(), UpdaterService::fillDescriptions(), HLTHcalMETNoiseFilter::fillDescriptions(), HLTRFilter::fillDescriptions(), HLTRHemisphere::fillDescriptions(), HLTForwardBackwardJetsFilter::fillDescriptions(), edm::StreamerOutputModule< Consumer >::fillDescriptions(), edm::AsciiOutputModule::fillDescriptions(), HLTExclDiJetFilter::fillDescriptions(), HLTDiJetAveFilter::fillDescriptions(), edm::service::UnixSignalService::fillDescriptions(), HLTMhtHtFilter::fillDescriptions(), edm::service::SimpleProfiling::fillDescriptions(), edm::service::CPU::fillDescriptions(), edm::StreamerFileReader::fillDescriptions(), RandomEngineStateProducer::fillDescriptions(), HLTBool::fillDescriptions(), edm::ProvenanceCheckerOutputModule::fillDescriptions(), edm::PoolSource::fillDescriptions(), edm::GetProductCheckerOutputModule::fillDescriptions(), HLT1CaloJetEnergy::fillDescriptions(), HLTLevel1Pattern::fillDescriptions(), edm::rootfix::LockService::fillDescriptions(), LogErrorFilter::fillDescriptions(), edm::LogErrorHarvester::fillDescriptions(), edm::service::Timing::fillDescriptions(), edm::service::Tracer::fillDescriptions(), HLTLevel1Activity::fillDescriptions(), edm::service::LoadAllDictionaries::fillDescriptions(), EventIDChecker::fillDescriptions(), edm::PrintEventSetupDataRetrieval::fillDescriptions(), edm::service::SiteLocalConfigService::fillDescriptions(), edm::PrintEventSetupContent::fillDescriptions(), pat::PATPhotonProducer::fillDescriptions(), PrintLoadingPlugins::fillDescriptions(), edm::XMLOutputModule::fillDescriptions(), edm::PoolOutputModule::fillDescriptions(), edm::EventSetupRecordDataGetter::fillDescriptions(), edm::service::RandomNumberGeneratorService::fillDescriptions(), pat::PATJetProducer::fillDescriptions(), JetCollectionForEleHT::fillDescriptions(), MulticoreRunLumiEventChecker::fillDescriptions(), edm::service::SimpleMemoryCheck::fillDescriptions(), edm::service::PrescaleService::fillDescriptions(), pat::PATElectronProducer::fillDescriptions(), pat::JetCorrFactorsProducer::fillDescriptions(), edm::service::EnableFloatingPointExceptions::fillDescriptions(), and edm::EventContentAnalyzer::fillDescriptions().

                                                                                 {

    if (baseType_ == std::string("Source")) {
      if (label != std::string("source")) {
        throw edm::Exception(edm::errors::LogicError,
          "ConfigurationDescriptions::add, when adding a ParameterSetDescription for a source the label must be \"source\"\n");
      }
      if (descriptions_.size() != 0U ||
          defaultDescDefined_ == true) {
        throw edm::Exception(edm::errors::LogicError,
          "ConfigurationDescriptions::add, for a source only 1 ParameterSetDescription may be added\n");
      }
    }
    else if (baseType_ == std::string("Service")) {
      if (descriptions_.size() != 0U ||
          defaultDescDefined_ == true) {
        throw edm::Exception(edm::errors::LogicError,
          "ConfigurationDescriptions::add, for a service only 1 ParameterSetDescription may be added\n");
      }
    }

    // To minimize the number of copies involved create an empty description first
    // and push it into the vector.  Then perform the copy.
    std::pair<std::string, ParameterSetDescription> pairWithEmptyDescription;
    descriptions_.push_back(pairWithEmptyDescription);
    std::pair<std::string, ParameterSetDescription> & pair = descriptions_.back();

    pair.first = label;
    pair.second = psetDescription;

    if (baseType_ == std::string("ESSource") || baseType_ == std::string("ESProducer")) {
      std::string name("appendToDataLabel");
      if (pair.second.isLabelUnused(name)) {
        pair.second.add<std::string>(name, std::string(""));
      }
    }
  }

void ConfigurationDescriptions::add	(	char const *	label,
		ParameterSetDescription const &	psetDescription
	)

Definition at line 53 of file ConfigurationDescriptions.cc.

References add().

                                                                                 {
    std::string labelString(label);
    add(labelString, psetDescription);
  }

void ConfigurationDescriptions::addDefault

(

ParameterSetDescription const &

psetDescription

)

Definition at line 100 of file ConfigurationDescriptions.cc.

References edm::ParameterSetDescription::add(), baseType_, defaultDesc_, defaultDescDefined_, descriptions_, edm::hlt::Exception, edm::ParameterSetDescription::isLabelUnused(), edm::errors::LogicError, and mergeVDriftHistosByStation::name.

Referenced by edm::EDAnalyzer::fillDescriptions(), edm::EDProducer::fillDescriptions(), edm::EDFilter::fillDescriptions(), PythonService::fillDescriptions(), fltrname::fillDescriptions(), anlzrname::fillDescriptions(), prodname::fillDescriptions(), EmDQMFeeder::fillDescriptions(), edm::service::JobReportService::fillDescriptions(), edm::OutputModule::fillDescriptions(), edm::InputSource::fillDescriptions(), DQMRootOutputModule::fillDescriptions(), DQMRootSource::fillDescriptions(), and edm::fillDetails::DoFillAsUnknown< T >::operator()().

                                                                                      {

    if (baseType_ == std::string("Source") || baseType_ == std::string("Service")) {
      if (descriptions_.size() != 0U ||
          defaultDescDefined_ == true) {
        throw edm::Exception(edm::errors::LogicError,
          "ConfigurationDescriptions::addDefault, for a source or service only 1 ParameterSetDescription may be added\n");
      }
    }

    defaultDescDefined_ = true;
    defaultDesc_ = psetDescription;

    if (baseType_ == std::string("ESSource") || baseType_ == std::string("ESProducer")) {
      std::string name("appendToDataLabel");
      if (defaultDesc_.isLabelUnused(name)) {
        defaultDesc_.add<std::string>(name, std::string(""));
      }
    }
  }

std::string const& edm::ConfigurationDescriptions::comment ( ) const

inline

Definition at line 39 of file ConfigurationDescriptions.h.

References comment_.

Referenced by print().

{ return comment_; }

void ConfigurationDescriptions::print	(	std::ostream &	os,
		std::string const &	moduleLabel,
		bool	brief,
		bool	printOnlyLabels,
		size_t	lineWidth,
		int	indentation,
		int	iPlugin
	)		const

Definition at line 199 of file ConfigurationDescriptions.cc.

References comment(), cmsDriverOptions::counter, defaultDesc_, defaultDescDefined_, descriptions_, relativeConstraints::empty, edm::for_all(), edm::ConfigurationDescriptions::DescriptionCounter::iModule, edm::ConfigurationDescriptions::DescriptionCounter::iPlugin, edm::ConfigurationDescriptions::DescriptionCounter::iSelectedModule, edm::ParameterSetDescription::isUnknown(), edm::DocFormatHelper::offsetModuleLabel(), printForLabel(), and edm::DocFormatHelper::wrapAndPrintText().

                                                           {
    if (!brief) {
      if (!comment().empty()) {
        DocFormatHelper::wrapAndPrintText(os, comment(), indentation, lineWidth);
      }
      os << "\n";
    }

    char oldFill = os.fill();
    if (descriptions_.empty() && !defaultDescDefined_) {
      indentation += DocFormatHelper::offsetModuleLabel();
      os << std::setfill(' ') << std::setw(indentation) << "";
      os << "There are no PSet descriptions defined for this plugin.\n";
      os << std::setfill(' ') << std::setw(indentation) << "";
      os << "PSets will not be validated and no cfi files will be generated.\n";
      if (!brief) os << "\n";
      os.fill(oldFill);
      return;
    }

    if (descriptions_.empty() && defaultDescDefined_ && defaultDesc_.isUnknown()) {
      indentation += DocFormatHelper::offsetModuleLabel();
      os << std::setfill(' ') << std::setw(indentation) << "";
      os << "This plugin has not implemented the function which defines its\n";
      os << std::setfill(' ') << std::setw(indentation) << "";
      os << "configuration descriptions yet. No descriptions are available.\n";
      os << std::setfill(' ') << std::setw(indentation) << "";
      os << "Its PSets will not be validated, and no cfi files will be generated.\n";
      if (!brief) os << "\n";
      os.fill(oldFill);
      return;
    }

    if (!brief) {
      std::stringstream ss;
      if (defaultDescDefined_) {
        if (descriptions_.empty()) {
          ss << "This plugin has only one PSet description. "
             << "This description is always used to validate configurations. "
             << "Because this configuration has no label, no cfi files will be generated.";
        }
        else {
          ss << "This plugin has " << (descriptions_.size() + 1U) << " PSet descriptions. "
             << "The description used to validate a configuration is selected by "
             << "matching the module labels. If none match, then the last description, "
             << "which has no label, is selected. "
             << "A cfi file will be generated for each configuration with a module label.";
        }
      }
      else {
        if (descriptions_.size() == 1U) {
          ss << "This plugin has " << descriptions_.size() << " PSet description. "
             << "This description is always used to validate configurations. "
             << "The label below is used when generating the cfi file.";
        }
        else {
          ss << "This plugin has " << descriptions_.size() << " PSet descriptions. "
             << "The description used to validate a configuration is selected by "
             << "matching the module labels. If none match the first description below is used. "
             << "The module labels below are also used when generating the cfi files.";
        }
      }
      DocFormatHelper::wrapAndPrintText(os, ss.str(), indentation, lineWidth);
      os << "\n";
    }

    indentation += DocFormatHelper::offsetModuleLabel();

    DescriptionCounter counter;
    counter.iPlugin = iPlugin;
    counter.iSelectedModule = 0;
    counter.iModule = 0;

    for_all(descriptions_, boost::bind(&ConfigurationDescriptions::printForLabel,
                                       this,
                                       _1,
                                       boost::ref(os),
                                       boost::cref(moduleLabel),
                                       brief,
                                       printOnlyLabels,
                                       lineWidth,
                                       indentation,
                                       boost::ref(counter)));

    if (defaultDescDefined_) {
      printForLabel(os,
                    std::string("@default"),
                    defaultDesc_,
                    moduleLabel,
                    brief,
                    printOnlyLabels,
                    lineWidth,
                    indentation,
                    counter);
    }
  }

void ConfigurationDescriptions::printForLabel ( std::pair< std::string, ParameterSetDescription > const &  labelAndDesc, std::ostream &  os, std::string const &  moduleLabel, bool  brief, bool  printOnlyLabels, size_t  lineWidth, int  indentationn, DescriptionCounter &  counter  ) const

private

Definition at line 303 of file ConfigurationDescriptions.cc.

Referenced by print().

  {
    printForLabel(os,
                  labelAndDesc.first,
                  labelAndDesc.second,
                  moduleLabel,
                  brief,
                  printOnlyLabels,
                  lineWidth,
                  indentation,
                  counter);
  }

void ConfigurationDescriptions::printForLabel ( std::ostream &  os, std::string const &  label, ParameterSetDescription const &  description, std::string const &  moduleLabel, bool  brief, bool  printOnlyLabels, size_t  lineWidth, int  indentationn, DescriptionCounter &  counter  ) const

private

Definition at line 324 of file ConfigurationDescriptions.cc.

References baseType_, edm::ParameterSetDescription::comment(), edm::ConfigurationDescriptions::DescriptionCounter::iModule, edm::ConfigurationDescriptions::DescriptionCounter::iPlugin, edm::ConfigurationDescriptions::DescriptionCounter::iSelectedModule, moduleLabel(), edm::DocFormatHelper::offsetTopLevelPSet(), edm::ParameterSetDescription::print(), edm::DocFormatHelper::setBrief(), edm::DocFormatHelper::setIndentation(), edm::DocFormatHelper::setLineWidth(), edm::DocFormatHelper::setParent(), edm::DocFormatHelper::setSection(), edm::DocFormatHelper::TOP, and edm::DocFormatHelper::wrapAndPrintText().

  {
    ++counter.iModule;
    if (!moduleLabel.empty() && label != moduleLabel) return;
    ++counter.iSelectedModule;

    std::stringstream ss;
    ss << counter.iPlugin << "." << counter.iSelectedModule;
    std::string section = ss.str();

    char oldFill = os.fill();
    os << std::setfill(' ') << std::setw(indentation) << "";
    os.fill(oldFill);
    os << section << " ";
    if (label == std::string("@default")) {
      os << "description without a module label\n";
    }
    else {
      if (!brief) {
        if (baseType_ == std::string("Source") || baseType_ == std::string("Service")) {
          os << "label: ";
        }
        else {
          os << "module label: ";
        }
      }
      os << label << "\n";      
    }

    if (!brief) {
      if (!description.comment().empty()) {
        DocFormatHelper::wrapAndPrintText(os, description.comment(), indentation, lineWidth - indentation);        
      }
      os << "\n";
    }
    if (printOnlyLabels) return;

    DocFormatHelper dfh;
    dfh.setBrief(brief);
    dfh.setLineWidth(lineWidth);
    dfh.setIndentation(indentation + DocFormatHelper::offsetTopLevelPSet());
    dfh.setSection(section);
    dfh.setParent(DocFormatHelper::TOP);

    description.print(os, dfh);
  }

void ConfigurationDescriptions::setComment

(

std::string const &

value

)

Definition at line 45 of file ConfigurationDescriptions.cc.

References comment_, and relativeConstraints::value.

Referenced by jetTools.RunBTagging::apply(), cmsswVersionTools.RunBTagging35X::apply(), edm::service::UnixSignalService::fillDescriptions(), edm::service::Tracer::fillDescriptions(), edm::service::Timing::fillDescriptions(), edm::service::LoadAllDictionaries::fillDescriptions(), edm::PrintEventSetupDataRetrieval::fillDescriptions(), edm::PrintEventSetupContent::fillDescriptions(), PrintLoadingPlugins::fillDescriptions(), edm::EventSetupRecordDataGetter::fillDescriptions(), edm::service::EnableFloatingPointExceptions::fillDescriptions(), and edm::EventContentAnalyzer::fillDescriptions().

  { comment_ = value; }

void ConfigurationDescriptions::setComment

(

char const *

value

)

Definition at line 49 of file ConfigurationDescriptions.cc.

References comment_, and relativeConstraints::value.

Referenced by jetTools.RunBTagging::apply(), and cmsswVersionTools.RunBTagging35X::apply().

  { comment_ = value; }

void ConfigurationDescriptions::validate	(	ParameterSet &	pset,
		std::string const &	moduleLabel
	)		const

Definition at line 122 of file ConfigurationDescriptions.cc.

References defaultDesc_, defaultDescDefined_, descriptions_, edm::for_all(), and edm::ParameterSetDescription::validate().

Referenced by edm::makeInput(), edm::Maker::makeWorker(), and edm::eventsetup::validateEventSetupParameters().

                                                                          {
    
    ParameterSetDescription const* psetDesc = 0;
    for_all(descriptions_, boost::bind(&matchLabel,
                                       _1,
                                       boost::cref(moduleLabel),
                                       boost::ref(psetDesc)));

    // If there is a matching label
    if (psetDesc != 0) {
      psetDesc->validate(pset);
    }
    // Is there an explicit description to be used for a non standard label
    else if (defaultDescDefined_) {
      defaultDesc_.validate(pset);
    }
    // Otherwise use the first one.
    else if (descriptions_.size() > 0U) {
      descriptions_[0].second.validate(pset);
    }
    // It is possible for no descriptions to be defined and no validation occurs
    // for this module ever.
  }

void ConfigurationDescriptions::writeCfiForLabel ( std::pair< std::string, ParameterSetDescription > const &  labelAndDesc, std::string const &  baseType, std::string const &  pluginName  )

staticprivate

Definition at line 159 of file ConfigurationDescriptions.cc.

References gather_cfg::cout, edm::hlt::Exception, and edm::errors::LogicError.

Referenced by writeCfis().

  {
    if (baseType == std::string("Service") && labelAndDesc.first != pluginName) {
      throw edm::Exception(edm::errors::LogicError,
        "ConfigurationDescriptions::writeCfiForLabel\nFor a service the label and the plugin name must be the same.\n")
        << "This error probably is caused by an incorrect label being passed\nto the ConfigurationDescriptions::add function earlier.\n"
        << "plugin name = \"" << pluginName << "\"  label name = \"" << labelAndDesc.first << "\"\n";
    }

    std::string cfi_filename;
    if (baseType == std::string("Source")) {
      cfi_filename = pluginName + "_cfi.py";
    }
    else {
      cfi_filename = labelAndDesc.first + "_cfi.py";
    }
    std::ofstream outFile(cfi_filename.c_str());


    outFile << "import FWCore.ParameterSet.Config as cms\n\n";
    outFile << labelAndDesc.first << " = cms." << baseType << "('" << pluginName << "'";

    bool startWithComma = true;
    int indentation = 2;
    labelAndDesc.second.writeCfi(outFile, startWithComma, indentation);

    outFile << ")\n";
  
    outFile.close();

    if (baseType == std::string("Source")) {
      std::cout << pluginName << "\n";
    }
    else {
      std::cout << labelAndDesc.first << "\n";
    }
  }

void ConfigurationDescriptions::writeCfis	(	std::string const &	baseType,
		std::string const &	pluginName
	)		const

Definition at line 148 of file ConfigurationDescriptions.cc.

References descriptions_, edm::for_all(), and writeCfiForLabel().

                                                                          {

    for_all(descriptions_, boost::bind(&ConfigurationDescriptions::writeCfiForLabel,
                                       _1,
                                       boost::cref(baseType),
                                       boost::cref(pluginName)));
  }

Member Data Documentation

std::string edm::ConfigurationDescriptions::baseType_

private

Definition at line 99 of file ConfigurationDescriptions.h.

Referenced by add(), addDefault(), and printForLabel().

std::string edm::ConfigurationDescriptions::comment_

private

Definition at line 106 of file ConfigurationDescriptions.h.

Referenced by comment(), and setComment().

ParameterSetDescription edm::ConfigurationDescriptions::defaultDesc_

private

Definition at line 104 of file ConfigurationDescriptions.h.

Referenced by addDefault(), print(), and validate().

bool edm::ConfigurationDescriptions::defaultDescDefined_

private

Definition at line 103 of file ConfigurationDescriptions.h.

Referenced by add(), addDefault(), print(), and validate().

std::vector<std::pair<std::string, ParameterSetDescription> > edm::ConfigurationDescriptions::descriptions_

private

Definition at line 101 of file ConfigurationDescriptions.h.

Referenced by add(), addDefault(), print(), validate(), and writeCfis().