edm::ParameterDescriptionBase Class Reference

#include <ParameterDescriptionBase.h>

Inheritance diagram for edm::ParameterDescriptionBase:

Public Member Functions
bool	hasDefault () const
bool	isTracked () const
std::string const &	label () const
virtual ParameterSetDescription const *	parameterSetDescription () const
virtual ParameterSetDescription *	parameterSetDescription ()
ParameterTypes	type () const
	~ParameterDescriptionBase () 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 &startWithComma, int indentation, bool &wroteSomething) const
virtual	~ParameterDescriptionNode ()

Protected Member Functions
	ParameterDescriptionBase (std::string const &iLabel, ParameterTypes iType, bool isTracked, bool hasDefault, Comment const &iComment)
	ParameterDescriptionBase (char const *iLabel, ParameterTypes iType, bool isTracked, bool hasDefault, Comment const &iComment)
void	throwMissingRequiredNoDefault () const
void	throwParameterWrongTrackiness () const
void	throwParameterWrongType () const
Protected Member Functions inherited from edm::ParameterDescriptionNode
virtual bool	exists_ (ParameterSet const &pset) const =0
virtual bool	hasNestedContent_ () const

Private Member Functions
void	checkAndGetLabelsAndTypes_ (std::set< std::string > &usedLabels, std::set< ParameterTypes > &parameterTypes, std::set< ParameterTypes > &wildcardTypes) const override
virtual bool	exists_ (ParameterSet const &pset, bool isTracked) const =0
int	howManyXORSubNodesExist_ (ParameterSet const &pset) const override
virtual void	insertDefault_ (ParameterSet &pset) const =0
bool	partiallyExists_ (ParameterSet const &pset) const override
void	print_ (std::ostream &os, bool optional, bool writeToCfi, DocFormatHelper &dfh) const override
virtual void	printDefault_ (std::ostream &os, bool writeToCfi, DocFormatHelper &dfh) const
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	writeCfi_ (std::ostream &os, bool &startWithComma, int indentation, bool &wroteSomething) const override
virtual void	writeCfi_ (std::ostream &os, int indentation) const =0
virtual void	writeDoc_ (std::ostream &os, int indentation) const =0

Private Attributes
bool	hasDefault_
bool	isTracked_
std::string	label_
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 33 of file ParameterDescriptionBase.h.

Constructor & Destructor Documentation

ParameterDescriptionBase::~ParameterDescriptionBase ( )

override

Definition at line 50 of file ParameterDescriptionBase.cc.

{}

ParameterDescriptionBase::ParameterDescriptionBase ( std::string const &  iLabel, ParameterTypes  iType, bool  isTracked, bool  hasDefault, Comment const &  iComment  )

protected

Definition at line 24 of file ParameterDescriptionBase.cc.

References Exception, label_, and edm::errors::LogicError.

Referenced by parameterSetDescription().

      : ParameterDescriptionNode(iComment),
        label_(iLabel),
        type_(iType),
        isTracked_(isTracked),
        hasDefault_(hasDefault) {
    if (label_.empty()) {
      throw Exception(errors::LogicError) << "Empty string used as a label for a parameter.  This is\n"
                                             "not allowed.\n";
    }
  }

ParameterDescriptionBase::ParameterDescriptionBase ( char const *  iLabel, ParameterTypes  iType, bool  isTracked, bool  hasDefault, Comment const &  iComment  )

protected

Definition at line 37 of file ParameterDescriptionBase.cc.

References Exception, label_, and edm::errors::LogicError.

      : ParameterDescriptionNode(iComment),
        label_(iLabel),
        type_(iType),
        isTracked_(isTracked),
        hasDefault_(hasDefault) {
    if (label_.empty()) {
      throw Exception(errors::LogicError) << "Empty string used as a label for a parameter.  This is\n"
                                             "not allowed.\n";
    }
  }

Member Function Documentation

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

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 91 of file ParameterDescriptionBase.cc.

References label(), and type().

Referenced by parameterSetDescription().

                                                                                             {
    usedLabels.insert(label());
    parameterTypes.insert(type());
  }

virtual bool edm::ParameterDescriptionBase::exists_ ( ParameterSet const &  pset, bool  isTracked  ) const

privatepure virtual

Implemented in edm::ParameterDescription< std::vector< ParameterSet > >, edm::ParameterDescription< ParameterSetDescription >, edm::ParameterDescription< T >, and edm::ParameterDescription< std::vector< std::string > >.

Referenced by parameterSetDescription(), and validate_().

bool edm::ParameterDescriptionBase::hasDefault ( ) const

inline

Definition at line 40 of file ParameterDescriptionBase.h.

References hasDefault_.

Referenced by parameterSetDescription(), printDefault_(), edm::ParameterDescription< std::vector< ParameterSet > >::printNestedContent_(), validate_(), edm::ParameterDescription< std::vector< ParameterSet > >::validate_(), and writeCfi_().

{ return hasDefault_; }

int ParameterDescriptionBase::howManyXORSubNodesExist_ ( ParameterSet const &  pset ) const

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 243 of file ParameterDescriptionBase.cc.

References edm::ParameterDescriptionNode::exists().

Referenced by parameterSetDescription().

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

virtual void edm::ParameterDescriptionBase::insertDefault_ ( ParameterSet &  pset ) const

privatepure virtual

Implemented in edm::ParameterDescription< std::vector< ParameterSet > >, edm::ParameterDescription< ParameterSetDescription >, edm::ParameterDescription< T >, and edm::ParameterDescription< std::vector< std::string > >.

Referenced by parameterSetDescription(), and validate_().

bool edm::ParameterDescriptionBase::isTracked ( ) const

inline

Definition at line 39 of file ParameterDescriptionBase.h.

References isTracked_.

Referenced by Types.PSet::clone(), Mixins._ParameterTypeBase::configTypeName(), edm::ParameterDescription< ParameterSetDescription >::exists_(), edm::ParameterDescription< std::vector< ParameterSet > >::exists_(), Types.int32::insertInto(), Types.uint32::insertInto(), Types.int64::insertInto(), Types.uint64::insertInto(), Types.double::insertInto(), Mixins.UsingBlock::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(), parameterSetDescription(), print_(), Mixins._ParameterTypeBase::pythonTypeName(), throwMissingRequiredNoDefault(), throwParameterWrongTrackiness(), throwParameterWrongType(), validate_(), edm::ParameterDescription< ParameterSetDescription >::validate_(), edm::ParameterDescription< std::vector< ParameterSet > >::validate_(), and writeCfi_().

{ return isTracked_; }

std::string const& edm::ParameterDescriptionBase::label ( ) const

inline

Definition at line 37 of file ParameterDescriptionBase.h.

References label_.

Referenced by checkAndGetLabelsAndTypes_(), edm::ParameterDescription< ParameterSetDescription >::exists_(), edm::ParameterDescription< std::vector< ParameterSet > >::exists_(), edm::ParameterSwitch< T >::ParameterSwitch(), edm::AllowedLabelsDescriptionBase::print_(), print_(), printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescription< std::vector< ParameterSet > >::printNestedContent_(), edm::AllowedLabelsDescriptionBase::printNestedContentBase_(), throwMissingRequiredNoDefault(), throwParameterWrongTrackiness(), throwParameterWrongType(), edm::AllowedLabelsDescriptionBase::validate_(), validate_(), edm::ParameterDescription< ParameterSetDescription >::validate_(), edm::ParameterDescription< std::vector< ParameterSet > >::validate_(), and writeCfi_().

{ return label_; }

virtual ParameterSetDescription const* edm::ParameterDescriptionBase::parameterSetDescription ( ) const

inlinevirtual

Reimplemented in edm::ParameterDescription< std::vector< ParameterSet > >, and edm::ParameterDescription< ParameterSetDescription >.

Definition at line 42 of file ParameterDescriptionBase.h.

{ return nullptr; }

virtual ParameterSetDescription* edm::ParameterDescriptionBase::parameterSetDescription ( )

inlinevirtual

Reimplemented in edm::ParameterDescription< std::vector< ParameterSet > >, and edm::ParameterDescription< ParameterSetDescription >.

Definition at line 43 of file ParameterDescriptionBase.h.

References checkAndGetLabelsAndTypes_(), exists_(), edm::ParameterDescriptionNode::exists_(), hasDefault(), howManyXORSubNodesExist_(), insertDefault_(), isTracked(), ParameterDescriptionBase(), partiallyExists_(), print_(), printDefault_(), printNestedContent_(), muonDTDigis_cfi::pset, AlCaHLTBitMon_QueryRunRegistry::string, throwMissingRequiredNoDefault(), throwParameterWrongTrackiness(), throwParameterWrongType(), validate_(), writeCfi_(), and writeDoc_().

{ return nullptr; }

bool ParameterDescriptionBase::partiallyExists_ ( ParameterSet const &  pset ) const

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 241 of file ParameterDescriptionBase.cc.

References edm::ParameterDescriptionNode::exists().

Referenced by parameterSetDescription().

{ return exists(pset); }

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

overrideprivatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 144 of file ParameterDescriptionBase.cc.

References edm::DocFormatHelper::brief(), edm::DocFormatHelper::column1(), edm::DocFormatHelper::column2(), edm::DocFormatHelper::column3(), edm::ParameterDescriptionNode::comment(), edm::DocFormatHelper::commentWidth(), relativeConstraints::empty, edm::DocFormatHelper::indent(), edm::DocFormatHelper::indent2(), isTracked(), label(), edm::parameterTypeEnumToString(), edm::DocFormatHelper::pass(), printDefault_(), edm::DocFormatHelper::setAtLeast1(), edm::DocFormatHelper::setAtLeast2(), edm::DocFormatHelper::setAtLeast3(), findQualityFiles::size, edm::DocFormatHelper::startColumn2(), type(), mitigatedMETSequence_cff::U, and edm::DocFormatHelper::wrapAndPrintText().

Referenced by parameterSetDescription().

                                                                                                                  {
    if (dfh.pass() == 0) {
      dfh.setAtLeast1(label().size());
      if (isTracked()) {
        dfh.setAtLeast2(parameterTypeEnumToString(type()).size());
      } else {
        dfh.setAtLeast2(parameterTypeEnumToString(type()).size() + 10U);
      }
      if (optional) {
        dfh.setAtLeast3(8U);
      }
    } else {
      if (dfh.brief()) {
        std::ios::fmtflags oldFlags = os.flags();

        dfh.indent(os);
        os << std::left << std::setw(dfh.column1()) << label() << " ";

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

        os << std::setw(dfh.column3());
        if (optional) {
          os << "optional";
        } else {
          os << "";
        }
        os << " ";
        os.flags(oldFlags);
        printDefault_(os, writeToCfi, dfh);
      } else {
        // not brief
        dfh.indent(os);
        os << label() << "\n";

        dfh.indent2(os);
        os << "type: ";
        if (!isTracked())
          os << "untracked ";

        os << parameterTypeEnumToString(type()) << " ";

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

        dfh.indent2(os);
        printDefault_(os, writeToCfi, dfh);

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

void ParameterDescriptionBase::printDefault_ ( std::ostream &  os, bool  writeToCfi, DocFormatHelper &  dfh  ) const

privatevirtual

Reimplemented in edm::ParameterDescription< std::vector< ParameterSet > >, and edm::ParameterDescription< ParameterSetDescription >.

Definition at line 208 of file ParameterDescriptionBase.cc.

References edm::DocFormatHelper::brief(), edm::DocFormatHelper::counter(), hasDefault(), edm::ParameterDescriptionNode::hasNestedContent(), edm::DocFormatHelper::indentation(), edm::DocFormatHelper::section(), edm::DocFormatHelper::startColumn2(), and writeDoc_().

Referenced by parameterSetDescription(), and print_().

                                                                                                          {
    if (!dfh.brief())
      os << "default: ";
    if (writeToCfi && hasDefault()) {
      if (hasNestedContent()) {
        os << "see Section " << dfh.section() << "." << dfh.counter();
      } else {
        if (dfh.brief()) {
          writeDoc_(os, dfh.indentation());
        } else {
          writeDoc_(os, dfh.startColumn2());
        }
      }
    } else {
      os << "none (do not write to cfi)";
    }
    os << "\n";
  }

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

overrideprivatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 227 of file ParameterDescriptionBase.cc.

References edm::DocFormatHelper::brief(), edm::DocFormatHelper::counter(), edm::DocFormatHelper::indentation(), label(), edm::DocFormatHelper::offsetSectionContent(), edm::DocFormatHelper::parent(), edm::ParameterDescriptionNode::printSpaces(), edm::DocFormatHelper::section(), edm::DocFormatHelper::TOP, and writeDoc_().

Referenced by parameterSetDescription().

                                                                                                       {
    int indentation = dfh.indentation();
    if (dfh.parent() != DocFormatHelper::TOP) {
      indentation -= DocFormatHelper::offsetSectionContent();
    }

    printSpaces(os, indentation);
    os << "Section " << dfh.section() << "." << dfh.counter() << " " << label() << " default contents: ";
    writeDoc_(os, indentation + 2);
    os << "\n";
    if (!dfh.brief())
      os << "\n";
  }

void ParameterDescriptionBase::throwMissingRequiredNoDefault ( ) const

protected

Definition at line 79 of file ParameterDescriptionBase.cc.

References edm::errors::Configuration, Exception, isTracked(), label(), edm::parameterTypeEnumToString(), AlCaHLTBitMon_QueryRunRegistry::string, and type().

Referenced by parameterSetDescription(), validate_(), and edm::ParameterDescription< std::vector< ParameterSet > >::validate_().

                                                                     {
    std::string tr("untracked");
    if (isTracked())
      tr = "tracked";

    throw Exception(errors::Configuration)
        << "Missing required parameter.  It should have label \"" << label() << "\" and have type \"" << tr << " "
        << parameterTypeEnumToString(type()) << "\".\n"
        << "The description has no default.  The parameter must be defined "
           "in the configuration\n";
  }

void ParameterDescriptionBase::throwParameterWrongTrackiness ( ) const

protected

Definition at line 52 of file ParameterDescriptionBase.cc.

References edm::errors::Configuration, Exception, isTracked(), label(), edm::parameterTypeEnumToString(), AlCaHLTBitMon_QueryRunRegistry::string, and type().

Referenced by parameterSetDescription(), validate_(), edm::ParameterDescription< ParameterSetDescription >::validate_(), and edm::ParameterDescription< std::vector< ParameterSet > >::validate_().

                                                                     {
    std::string tr("a tracked");
    std::string shouldBe("untracked");
    if (isTracked()) {
      tr = "an untracked";
      shouldBe = "tracked";
    }

    throw Exception(errors::Configuration) << "In the configuration, parameter \"" << label()
                                           << "\" is defined "
                                              "as "
                                           << tr << " " << parameterTypeEnumToString(type()) << ".\n"
                                           << "It should be " << shouldBe << ".\n";
  }

void ParameterDescriptionBase::throwParameterWrongType ( ) const

protected

Definition at line 67 of file ParameterDescriptionBase.cc.

References edm::errors::Configuration, Exception, isTracked(), label(), edm::parameterTypeEnumToString(), AlCaHLTBitMon_QueryRunRegistry::string, and type().

Referenced by parameterSetDescription(), validate_(), edm::ParameterDescription< ParameterSetDescription >::validate_(), and edm::ParameterDescription< std::vector< ParameterSet > >::validate_().

                                                               {
    std::string tr("an untracked");
    if (isTracked())
      tr = "a tracked";

    throw Exception(errors::Configuration) << "Parameter \"" << label()
                                           << "\" should be defined "
                                              "as "
                                           << tr << " " << parameterTypeEnumToString(type()) << ".\n"
                                           << "The type in the configuration is incorrect.\n";
  }

ParameterTypes edm::ParameterDescriptionBase::type ( ) const

inline

Definition at line 38 of file ParameterDescriptionBase.h.

References type_.

Referenced by checkAndGetLabelsAndTypes_(), print_(), throwMissingRequiredNoDefault(), throwParameterWrongTrackiness(), throwParameterWrongType(), and writeCfi_().

{ return type_; }

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

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 98 of file ParameterDescriptionBase.cc.

References edm::ParameterDescriptionNode::exists(), edm::ParameterSet::exists(), exists_(), hasDefault(), insertDefault_(), isTracked(), label(), throwMissingRequiredNoDefault(), throwParameterWrongTrackiness(), and throwParameterWrongType().

Referenced by parameterSetDescription().

                                                                {
    bool exists = exists_(pset, isTracked());

    if (exists) {
      validatedLabels.insert(label());
    } else if (exists_(pset, !isTracked())) {
      throwParameterWrongTrackiness();
    } else if (pset.exists(label())) {
      throwParameterWrongType();
    }

    if (!exists && !optional) {
      if (hasDefault()) {
        insertDefault_(pset);
        validatedLabels.insert(label());
      } else {
        throwMissingRequiredNoDefault();
      }
    }
  }

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

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 121 of file ParameterDescriptionBase.cc.

References hasDefault(), isTracked(), label(), edm::parameterTypeEnumToString(), edm::ParameterDescriptionNode::printSpaces(), and type().

Referenced by parameterSetDescription().

                                                                       {
    if (!hasDefault())
      return;

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

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

    os << label() << " = cms.";
    if (!isTracked())
      os << "untracked.";
    os << parameterTypeEnumToString(type()) << "(";
    writeCfi_(os, indentation);
    os << ")";
  }

virtual void edm::ParameterDescriptionBase::writeCfi_ ( std::ostream &  os, int  indentation  ) const

privatepure virtual

Implemented in edm::ParameterDescription< std::vector< ParameterSet > >, edm::ParameterDescription< ParameterSetDescription >, edm::ParameterDescription< T >, and edm::ParameterDescription< std::vector< std::string > >.

virtual void edm::ParameterDescriptionBase::writeDoc_ ( std::ostream &  os, int  indentation  ) const

privatepure virtual

Implemented in edm::ParameterDescription< std::vector< ParameterSet > >, edm::ParameterDescription< ParameterSetDescription >, edm::ParameterDescription< T >, and edm::ParameterDescription< std::vector< std::string > >.

Referenced by parameterSetDescription(), printDefault_(), and printNestedContent_().

Member Data Documentation

bool edm::ParameterDescriptionBase::hasDefault_

private

Definition at line 87 of file ParameterDescriptionBase.h.

Referenced by hasDefault().

bool edm::ParameterDescriptionBase::isTracked_

private

Definition at line 86 of file ParameterDescriptionBase.h.

Referenced by isTracked().

std::string edm::ParameterDescriptionBase::label_

private

Definition at line 84 of file ParameterDescriptionBase.h.

Referenced by SequenceTypes.DummyModule::__repr__(), Mixins._Labelable::_findDependencies(), label(), ParameterDescriptionBase(), and Mixins._Labelable::setLabel().

ParameterTypes edm::ParameterDescriptionBase::type_

private

Definition at line 85 of file ParameterDescriptionBase.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().