edm::ParameterWildcardWithSpecifics Class Reference

#include <ParameterWildcardWithSpecifics.h>

Inheritance diagram for edm::ParameterWildcardWithSpecifics:

Public Member Functions
ParameterDescriptionNode *	clone () const override
	ParameterWildcardWithSpecifics (std::string_view, WildcardValidationCriteria criteria, bool isTracked, ParameterSetDescription const &desc, std::map< std::string, ParameterSetDescription > exceptions)
Public Member Functions inherited from edm::ParameterWildcardBase
WildcardValidationCriteria	criteria () const
bool	isTracked () const
ParameterTypes	type () const
	~ParameterWildcardBase () override
Public Member Functions inherited from edm::ParameterDescriptionNode
void	checkAndGetLabelsAndTypes (std::set< std::string > &usedLabels, std::set< ParameterTypes > &parameterTypes, std::set< ParameterTypes > &wildcardTypes) const
std::string const &	comment () const
bool	exists (ParameterSet const &pset) const
bool	hasNestedContent () const
int	howManyXORSubNodesExist (ParameterSet const &pset) const
	ParameterDescriptionNode ()
	ParameterDescriptionNode (Comment const &iComment)
bool	partiallyExists (ParameterSet const &pset) const
void	print (std::ostream &os, bool optional, bool writeToCfi, DocFormatHelper &dfh) const
void	printNestedContent (std::ostream &os, bool optional, DocFormatHelper &dfh) const
void	setComment (char const *value)
void	setComment (std::string const &value)
void	validate (ParameterSet &pset, std::set< std::string > &validatedLabels, bool optional) const
void	writeCfi (std::ostream &os, bool optional, bool &startWithComma, int indentation, bool &wroteSomething) const
virtual	~ParameterDescriptionNode ()

Private Member Functions
bool	exists_ (ParameterSet const &pset) const override
bool	hasNestedContent_ () const override
void	printNestedContent_ (std::ostream &os, bool optional, DocFormatHelper &dfh) const override
void	validate_ (ParameterSet &pset, std::set< std::string > &validatedLabels, bool optional) const override
void	validateDescription (std::string const &parameterName, ParameterSet &pset) const
void	validatePSetVector (std::string const &parameterName, ParameterSet &pset) const

Private Attributes
std::map< std::string, ParameterSetDescription >	exceptions_
ParameterSetDescription	wildcardDesc_

Additional Inherited Members
Static Public Member Functions inherited from edm::ParameterDescriptionNode
static void	printSpaces (std::ostream &os, int n)
Protected Member Functions inherited from edm::ParameterWildcardBase
	ParameterWildcardBase (ParameterTypes iType, bool isTracked, WildcardValidationCriteria criteria)
void	throwIfInvalidPattern (char const *pattern) const
void	throwIfInvalidPattern (std::string const &pattern) const
void	validateMatchingNames (std::vector< std::string > const &matchingNames, std::set< std::string > &validatedLabels, bool optional) const
Protected Attributes inherited from edm::ParameterDescriptionNode
std::string	comment_

Detailed Description

Definition at line 15 of file ParameterWildcardWithSpecifics.h.

Constructor & Destructor Documentation

ParameterWildcardWithSpecifics()

edm::ParameterWildcardWithSpecifics::ParameterWildcardWithSpecifics	(	std::string_view	pattern,
		WildcardValidationCriteria	criteria,
		bool	isTracked,
		ParameterSetDescription const &	desc,
		std::map< std::string, ParameterSetDescription >	exceptions
	)

Definition at line 14 of file ParameterWildcardWithSpecifics.cc.

      : ParameterWildcardBase(k_PSet, isTracked, criteria), wildcardDesc_(desc), exceptions_(std::move(exceptions)) {
    throwIfInvalidPattern(std::string(pattern));
  }

References topSingleLeptonDQM_PU_cfi::pattern, AlCaHLTBitMon_QueryRunRegistry::string, and edm::ParameterWildcardBase::throwIfInvalidPattern().

Referenced by clone().

Member Function Documentation

clone()

ParameterDescriptionNode * edm::ParameterWildcardWithSpecifics::clone ( void  ) const

overridevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 24 of file ParameterWildcardWithSpecifics.cc.

                                                                        {
    return new ParameterWildcardWithSpecifics(*this);
  }

References ParameterWildcardWithSpecifics().

exists_()

bool edm::ParameterWildcardWithSpecifics::exists_ ( ParameterSet const &  pset ) const

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 90 of file ParameterWildcardWithSpecifics.cc.

                                                                             {
    if (criteria() == RequireZeroOrMore)
      return true;
 
    std::vector<std::string> parameterNames = pset.getParameterNamesForType<ParameterSet>(isTracked());
 
    if (criteria() == RequireAtLeastOne)
      return !parameterNames.empty();
    return parameterNames.size() == 1U;
  }

References edm::ParameterWildcardBase::criteria(), edm::ParameterSet::empty(), edm::ParameterWildcardBase::isTracked(), muonDTDigis_cfi::pset, edm::RequireAtLeastOne, edm::RequireZeroOrMore, and mitigatedMETSequence_cff::U.

hasNestedContent_()

bool edm::ParameterWildcardWithSpecifics::hasNestedContent_ ( ) const

overrideprivatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 61 of file ParameterWildcardWithSpecifics.cc.

{ return true; }

printNestedContent_()

void edm::ParameterWildcardWithSpecifics::printNestedContent_ ( std::ostream &  os, bool  optional, DocFormatHelper &  dfh  ) const

overrideprivatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 63 of file ParameterWildcardWithSpecifics.cc.

                                                                                       {
    int indentation = dfh.indentation();
    if (dfh.parent() != DocFormatHelper::TOP) {
      indentation -= DocFormatHelper::offsetSectionContent();
    }
 
    printSpaces(os, indentation);
    os << "Section " << dfh.section() << "." << dfh.counter() << " description of PSet matching wildcard:";
    os << "\n";
    if (!dfh.brief())
      os << "\n";
 
    std::stringstream ss;
    ss << dfh.section() << "." << dfh.counter();
    std::string newSection = ss.str();
 
    DocFormatHelper new_dfh(dfh);
    new_dfh.setSection(newSection);
    new_dfh.setIndentation(indentation + DocFormatHelper::offsetSectionContent());
    new_dfh.setParent(DocFormatHelper::OTHER);
 
    wildcardDesc_.print(os, new_dfh);
    //NOTE: need to extend to also include the specific cases.
  }

References edm::DocFormatHelper::brief(), edm::DocFormatHelper::counter(), printContent_cfi::indentation, edm::DocFormatHelper::indentation(), edm::DocFormatHelper::offsetSectionContent(), edm::DocFormatHelper::OTHER, edm::DocFormatHelper::parent(), edm::ParameterSetDescription::print(), edm::ParameterDescriptionNode::printSpaces(), edm::DocFormatHelper::section(), edm::DocFormatHelper::setIndentation(), edm::DocFormatHelper::setParent(), edm::DocFormatHelper::setSection(), contentValuesCheck::ss, AlCaHLTBitMon_QueryRunRegistry::string, edm::DocFormatHelper::TOP, and wildcardDesc_.

validate_()

void edm::ParameterWildcardWithSpecifics::validate_ ( ParameterSet &  pset, std::set< std::string > &  validatedLabels, bool  optional  ) const

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 28 of file ParameterWildcardWithSpecifics.cc.

                                                                      {
    std::vector<std::string> parameterNames = pset.getParameterNamesForType<ParameterSet>(isTracked());
    validateMatchingNames(parameterNames, validatedLabels, optional);
 
    for (auto const& name : parameterNames) {
      validateDescription(name, pset);
    }
    //inject exceptions if not already in the pset
    for (auto const& v : exceptions_) {
      if (std::find(parameterNames.begin(), parameterNames.end(), v.first) == parameterNames.end()) {
        if (isTracked()) {
          pset.addParameter<edm::ParameterSet>(v.first, edm::ParameterSet());
        } else {
          pset.addUntrackedParameter<edm::ParameterSet>(v.first, edm::ParameterSet());
        }
        validatedLabels.insert(v.first);
        validateDescription(v.first, pset);
      }
    }
  }

References exceptions_, spr::find(), edm::ParameterSet::insert(), edm::ParameterWildcardBase::isTracked(), Skims_PA_cff::name, Types::optional, muonDTDigis_cfi::pset, findQualityFiles::v, validateDescription(), and edm::ParameterWildcardBase::validateMatchingNames().

validateDescription()

void edm::ParameterWildcardWithSpecifics::validateDescription ( std::string const &  parameterName, ParameterSet &  pset  ) const

private

Definition at line 51 of file ParameterWildcardWithSpecifics.cc.

                                                                                                                   {
    ParameterSet* containedPSet = pset.getPSetForUpdate(parameterName);
    auto itFound = exceptions_.find(parameterName);
    if (itFound != exceptions_.end()) {
      itFound->second.validate(*containedPSet);
    } else {
      wildcardDesc_.validate(*containedPSet);
    }
  }

References exceptions_, muonDTDigis_cfi::pset, edm::ParameterSetDescription::validate(), and wildcardDesc_.

Referenced by validate_().

validatePSetVector()

void edm::ParameterWildcardWithSpecifics::validatePSetVector ( std::string const &  parameterName, ParameterSet &  pset  ) const

private

Member Data Documentation

exceptions_

std::map<std::string, ParameterSetDescription> edm::ParameterWildcardWithSpecifics::exceptions_

private

Definition at line 39 of file ParameterWildcardWithSpecifics.h.

Referenced by validate_(), and validateDescription().

wildcardDesc_

ParameterSetDescription edm::ParameterWildcardWithSpecifics::wildcardDesc_

private

Definition at line 38 of file ParameterWildcardWithSpecifics.h.

Referenced by printNestedContent_(), and validateDescription().