edm::ParameterWildcardBase Class Reference

#include <ParameterWildcardBase.h>

Inheritance diagram for edm::ParameterWildcardBase:

Public Member Functions
WildcardValidationCriteria	criteria () const
bool	isTracked () const
bool	isWildcard () const override
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
virtual ParameterDescriptionNode *	clone () const =0
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 (std::string const &value)
void	setComment (char 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 ()

Protected Member Functions
	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 Member Functions inherited from edm::ParameterDescriptionNode
virtual bool	exists_ (ParameterSet const &pset) const =0
virtual bool	hasNestedContent_ () const
virtual void	printNestedContent_ (std::ostream &, bool, DocFormatHelper &) const
virtual void	validate_ (ParameterSet &pset, std::set< std::string > &validatedLabels, bool optional) const =0

Private Member Functions
void	checkAndGetLabelsAndTypes_ (std::set< std::string > &usedLabels, std::set< ParameterTypes > &parameterTypes, std::set< ParameterTypes > &wildcardTypes) const override
int	howManyXORSubNodesExist_ (ParameterSet const &pset) const override
bool	partiallyExists_ (ParameterSet const &pset) const override
void	print_ (std::ostream &os, bool optional, bool writeToCfi, DocFormatHelper &dfh) const override
void	writeCfi_ (std::ostream &os, bool optional, bool &startWithComma, int indentation, bool &wroteSomething) const override
virtual void	writeTemplate (std::ostream &os, int indentation) const

Private Attributes
WildcardValidationCriteria	criteria_
bool	isTracked_
ParameterTypes	type_

Additional Inherited Members
Static Public Member Functions inherited from edm::ParameterDescriptionNode
static void	printSpaces (std::ostream &os, int n)
Protected Attributes inherited from edm::ParameterDescriptionNode
std::string	comment_

Detailed Description

Definition at line 19 of file ParameterWildcardBase.h.

Constructor & Destructor Documentation

~ParameterWildcardBase()

edm::ParameterWildcardBase::~ParameterWildcardBase ( )

override

Definition at line 13 of file ParameterWildcardBase.cc.

{}

ParameterWildcardBase()

edm::ParameterWildcardBase::ParameterWildcardBase ( ParameterTypes  iType, bool  isTracked, WildcardValidationCriteria  criteria  )

protected

Definition at line 15 of file ParameterWildcardBase.cc.

      : type_(iType), isTracked_(isTracked), criteria_(criteria) {}

Member Function Documentation

checkAndGetLabelsAndTypes_()

void edm::ParameterWildcardBase::checkAndGetLabelsAndTypes_ ( std::set< std::string > &  usedLabels, std::set< ParameterTypes > &  parameterTypes, std::set< ParameterTypes > &  wildcardTypes  ) const

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 58 of file ParameterWildcardBase.cc.

References type().

                                                                                                      {
    wildcardTypes.insert(type());
  }

criteria()

WildcardValidationCriteria edm::ParameterWildcardBase::criteria ( ) const

inline

Definition at line 25 of file ParameterWildcardBase.h.

References criteria_.

Referenced by edm::ParameterWildcardWithSpecifics::exists_(), edm::ParameterWildcard< T >::exists_(), edm::ParameterWildcard< ParameterSetDescription >::exists_(), and print_().

{ return criteria_; }

howManyXORSubNodesExist_()

int edm::ParameterWildcardBase::howManyXORSubNodesExist_ ( ParameterSet const &  pset ) const

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 178 of file ParameterWildcardBase.cc.

References edm::ParameterDescriptionNode::exists(), and muonDTDigis_cfi::pset.

{ return exists(pset) ? 1 : 0; }

isTracked()

bool edm::ParameterWildcardBase::isTracked ( ) const

inline

Definition at line 24 of file ParameterWildcardBase.h.

References isTracked_.

Referenced by Types.PSet::clone(), Mixins._ParameterTypeBase::configTypeName(), edm::ParameterWildcardWithSpecifics::exists_(), edm::ParameterWildcard< T >::exists_(), edm::ParameterWildcard< ParameterSetDescription >::exists_(), Mixins.UsingBlock::insertInto(), Types.int32::insertInto(), Types.uint32::insertInto(), Types.int64::insertInto(), Types.uint64::insertInto(), Types.double::insertInto(), Types.bool::insertInto(), Types.string::insertInto(), Types.EventID::insertInto(), Types.LuminosityBlockID::insertInto(), Types.LuminosityBlockRange::insertInto(), Types.EventRange::insertInto(), Types.InputTag::insertInto(), Types.ESInputTag::insertInto(), Types.FileInPath::insertInto(), Types.PSet::insertInto(), Types.vint32::insertInto(), Types.vuint32::insertInto(), Types.vint64::insertInto(), Types.vuint64::insertInto(), Types.vdouble::insertInto(), Types.vbool::insertInto(), Types.vstring::insertInto(), Types.VLuminosityBlockID::insertInto(), Types.VInputTag::insertInto(), Types.VESInputTag::insertInto(), Types.VEventID::insertInto(), Types.VLuminosityBlockRange::insertInto(), Types.VEventRange::insertInto(), Types.VPSet::insertInto(), print_(), Mixins._ParameterTypeBase::pythonTypeName(), edm::ParameterWildcardWithSpecifics::validate_(), edm::ParameterWildcard< T >::validate_(), edm::ParameterWildcard< ParameterSetDescription >::validate_(), and writeCfi_().

{ return isTracked_; }

isWildcard()

bool edm::ParameterWildcardBase::isWildcard ( ) const

inlineoverridevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 27 of file ParameterWildcardBase.h.

{ return true; }

partiallyExists_()

bool edm::ParameterWildcardBase::partiallyExists_ ( ParameterSet const &  pset ) const

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 176 of file ParameterWildcardBase.cc.

References edm::ParameterDescriptionNode::exists(), and muonDTDigis_cfi::pset.

{ return exists(pset); }

print_()

void edm::ParameterWildcardBase::print_ ( std::ostream &  os, bool  optional, bool  writeToCfi, DocFormatHelper &  dfh  ) const

overrideprivatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 64 of file ParameterWildcardBase.cc.

References edm::DocFormatHelper::brief(), edm::DocFormatHelper::column1(), edm::DocFormatHelper::column2(), edm::DocFormatHelper::column3(), edm::ParameterDescriptionNode::comment(), edm::DocFormatHelper::commentWidth(), edm::DocFormatHelper::counter(), criteria(), relativeConstraints::empty, edm::ParameterDescriptionNode::hasNestedContent(), edm::DocFormatHelper::indent(), edm::DocFormatHelper::indent2(), isTracked(), Types::optional, edm::parameterTypeEnumToString(), edm::DocFormatHelper::pass(), edm::RequireAtLeastOne, edm::RequireExactlyOne, edm::RequireZeroOrMore, edm::DocFormatHelper::section(), edm::DocFormatHelper::setAtLeast1(), edm::DocFormatHelper::setAtLeast2(), edm::DocFormatHelper::setAtLeast3(), contentValuesCheck::ss, edm::DocFormatHelper::startColumn2(), type(), mitigatedMETSequence_cff::U, and edm::DocFormatHelper::wrapAndPrintText().

                                                                                                      {
    if (dfh.pass() == 0) {
      dfh.setAtLeast1(11U);
      if (isTracked()) {
        dfh.setAtLeast2(parameterTypeEnumToString(type()).size());
      } else {
        dfh.setAtLeast2(parameterTypeEnumToString(type()).size() + 10U);
      }
      dfh.setAtLeast3(8U);
    } else {
      if (dfh.brief()) {
        dfh.indent(os);
        std::ios::fmtflags oldFlags = os.flags();
        os << std::left << std::setw(dfh.column1()) << "wildcard: *"
           << " ";

        if (isTracked()) {
          os << std::setw(dfh.column2()) << parameterTypeEnumToString(type());
        } else {
          std::stringstream ss;
          ss << "untracked " << parameterTypeEnumToString(type());
          os << ss.str();
        }

        os << " ";
        os << std::setw(dfh.column3());
        if (optional)
          os << "optional";
        else
          os << "";

        if (criteria() == RequireZeroOrMore) {
          os << " (require zero or more)";
        } else if (criteria() == RequireAtLeastOne) {
          os << " (require at least one)";
        } else if (criteria() == RequireExactlyOne) {
          os << " (require exactly one)";
        }
        os << "\n";
        if (hasNestedContent()) {
          dfh.indent(os);
          os << "  (see Section " << dfh.section() << "." << dfh.counter() << ")\n";
        }
        os.flags(oldFlags);
      } else {
        // not brief

        dfh.indent(os);
        os << "labels must match this wildcard pattern: *\n";

        dfh.indent2(os);
        os << "type: ";
        if (isTracked()) {
          os << parameterTypeEnumToString(type());
        } else {
          os << "untracked " << parameterTypeEnumToString(type());
        }

        if (optional)
          os << " optional";
        os << "\n";

        dfh.indent2(os);
        os << "criteria: ";
        if (criteria() == RequireZeroOrMore)
          os << "require zero or more";
        else if (criteria() == RequireAtLeastOne)
          os << "require at least one";
        else if (criteria() == RequireExactlyOne)
          os << "require exactly one";
        os << "\n";

        if (hasNestedContent()) {
          dfh.indent2(os);
          os << "(see Section " << dfh.section() << "." << dfh.counter() << ")\n";
        }

        if (!comment().empty()) {
          DocFormatHelper::wrapAndPrintText(os, comment(), dfh.startColumn2(), dfh.commentWidth());
        }
        os << "\n";
      }
    }
  }

throwIfInvalidPattern() [1/2]

void edm::ParameterWildcardBase::throwIfInvalidPattern ( char const *  pattern ) const

protected

Definition at line 20 of file ParameterWildcardBase.cc.

References topSingleLeptonDQM_PU_cfi::pattern, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by edm::ParameterWildcard< T >::ParameterWildcard(), edm::ParameterWildcard< ParameterSetDescription >::ParameterWildcard(), edm::ParameterWildcard< std::vector< ParameterSet > >::ParameterWildcard(), and edm::ParameterWildcardWithSpecifics::ParameterWildcardWithSpecifics().

                                                                             {
    std::string sPattern(pattern);
    throwIfInvalidPattern(sPattern);
  }

throwIfInvalidPattern() [2/2]

void edm::ParameterWildcardBase::throwIfInvalidPattern ( std::string const &  pattern ) const

protected

Definition at line 25 of file ParameterWildcardBase.cc.

References edm::errors::Configuration, Exception, edm::parameterTypeEnumToString(), topSingleLeptonDQM_PU_cfi::pattern, AlCaHLTBitMon_QueryRunRegistry::string, and type().

                                                                                  {
    if (pattern != std::string("*")) {
      throw Exception(errors::Configuration)
          << "Currently, the only supported wildcard in ParameterSetDescriptions\n"
          << "is the single character \"*\".  The configuration contains a wildcard\n"
          << "with pattern \"" << pattern << "\" and type \"" << parameterTypeEnumToString(type()) << "\"\n"
          << "At some future date, globbing or regular expression support may be added\n"
          << "if there are any requests for it from users.\n";
    }
  }

type()

ParameterTypes edm::ParameterWildcardBase::type ( ) const

inline

Definition at line 23 of file ParameterWildcardBase.h.

References type_.

Referenced by checkAndGetLabelsAndTypes_(), print_(), throwIfInvalidPattern(), validateMatchingNames(), and writeTemplate().

{ return type_; }

validateMatchingNames()

void edm::ParameterWildcardBase::validateMatchingNames ( std::vector< std::string > const &  matchingNames, std::set< std::string > &  validatedLabels, bool  optional  ) const

protected

Definition at line 36 of file ParameterWildcardBase.cc.

References edm::errors::Configuration, criteria_, Exception, Types::optional, edm::parameterTypeEnumToString(), edm::RequireAtLeastOne, edm::RequireExactlyOne, edm::RequireZeroOrMore, type(), and mitigatedMETSequence_cff::U.

Referenced by edm::ParameterWildcardWithSpecifics::validate_(), edm::ParameterWildcard< T >::validate_(), and edm::ParameterWildcard< ParameterSetDescription >::validate_().

                                                                         {
    validatedLabels.insert(matchingNames.begin(), matchingNames.end());
    if (criteria_ == RequireZeroOrMore)
      return;
    if (criteria_ == RequireAtLeastOne && matchingNames.empty() && !optional) {
      throw Exception(errors::Configuration)
          << "Parameter wildcard of type \"" << parameterTypeEnumToString(type()) << "\" requires "
          << "at least one match\n"
          << "and there are no parameters in the configuration matching\n"
          << "that type.\n";
    } else if (criteria_ == RequireExactlyOne) {
      if ((matchingNames.empty() && !optional) || matchingNames.size() > 1U) {
        throw Exception(errors::Configuration)
            << "Parameter wildcard of type \"" << parameterTypeEnumToString(type()) << "\" requires\n"
            << "exactly one match and there are " << matchingNames.size() << " matching parameters\n"
            << "in the configuration.\n";
      }
    }
  }

writeCfi_()

void edm::ParameterWildcardBase::writeCfi_ ( std::ostream &  os, bool  optional, bool &  startWithComma, int  indentation, bool &  wroteSomething  ) const

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 149 of file ParameterWildcardBase.cc.

References printContent_cfi::indentation, isTracked(), Types::optional, edm::ParameterDescriptionNode::printSpaces(), and writeTemplate().

                                                                                                        {
    wroteSomething = true;
    if (startWithComma)
      os << ",";
    startWithComma = true;

    os << "\n";
    printSpaces(os, indentation);

    os << "allowAnyLabel_ = cms.";

    if (optional) {
      os << "optional.";
    } else {
      os << "required.";
    }
    if (!isTracked())
      os << "untracked.";

    writeTemplate(os, indentation);
  }

writeTemplate()

void edm::ParameterWildcardBase::writeTemplate ( std::ostream &  os, int  indentation  ) const

privatevirtual

Reimplemented in edm::ParameterWildcard< ParameterSetDescription >.

Definition at line 172 of file ParameterWildcardBase.cc.

References edm::parameterTypeEnumToString(), and type().

Referenced by writeCfi_().

                                                                                 {
    os << parameterTypeEnumToString(type());
  }

Member Data Documentation

criteria_

WildcardValidationCriteria edm::ParameterWildcardBase::criteria_

private

Definition at line 56 of file ParameterWildcardBase.h.

Referenced by criteria(), and validateMatchingNames().

isTracked_

bool edm::ParameterWildcardBase::isTracked_

private

Definition at line 55 of file ParameterWildcardBase.h.

Referenced by isTracked().

type_

ParameterTypes edm::ParameterWildcardBase::type_

private

Definition at line 54 of file ParameterWildcardBase.h.

Referenced by Modules.Service::__str__(), Modules.Service::_placeImpl(), Modules.ESSource::_placeImpl(), Modules.ESProducer::_placeImpl(), Modules.ESPrefer::copy(), Mixins._TypedParameterizable::dumpPython(), Modules.ESPrefer::dumpPythonAs(), Modules.Service::dumpSequencePython(), RandomRunSource.RandomRunSource::insertInto(), Modules.Service::insertInto(), ExternalGeneratorFilter.ExternalGeneratorFilter::insertInto(), Mixins._TypedParameterizable::insertInto(), Modules.ESSource::moduleLabel_(), Modules.ESProducer::moduleLabel_(), Modules.ESSource::nameInProcessDesc_(), Modules.ESProducer::nameInProcessDesc_(), Modules.ESPrefer::nameInProcessDesc_(), and type().