edm::ParameterSwitchBase Class Reference

#include <ParameterSwitchBase.h>

Inheritance diagram for edm::ParameterSwitchBase:

Public Member Functions
	~ParameterSwitchBase () 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
bool	hasNestedContent_ () const override
void	insertAndCheckLabels (std::string const &switchLabel, std::set< std::string > &usedLabels, std::set< std::string > &labels) const
void	insertAndCheckTypes (ParameterTypes switchType, std::set< ParameterTypes > const &caseParameterTypes, std::set< ParameterTypes > const &caseWildcardTypes, std::set< ParameterTypes > &parameterTypes, std::set< ParameterTypes > &wildcardTypes) const
void	printBase (std::ostream &os, bool optional, bool writeToCfi, DocFormatHelper &dfh, std::string const &switchLabel, bool isTracked, std::string const &typeString) const
void	printNestedContentBase (std::ostream &os, DocFormatHelper &dfh, DocFormatHelper &new_dfh, std::string const &switchLabel) const
void	throwDuplicateCaseValues (std::string const &switchLabel) const
void	throwNoCaseForDefault (std::string const &switchLabel) const
void	throwNoCaseForSwitchValue (std::string const &message) const
Protected Member Functions inherited from edm::ParameterDescriptionNode
virtual void	checkAndGetLabelsAndTypes_ (std::set< std::string > &usedLabels, std::set< ParameterTypes > &parameterTypes, std::set< ParameterTypes > &wildcardTypes) const =0
virtual bool	exists_ (ParameterSet const &pset) const =0
virtual void	print_ (std::ostream &, bool, bool, DocFormatHelper &) const
virtual void	printNestedContent_ (std::ostream &, bool, DocFormatHelper &) const
virtual void	validate_ (ParameterSet &pset, std::set< std::string > &validatedLabels, bool optional) const =0
virtual void	writeCfi_ (std::ostream &os, bool &startWithComma, int indentation, bool &wroteSomething) const =0

Static Protected Member Functions
template<typename T >
static void	printCaseT (std::pair< T, edm::value_ptr< ParameterDescriptionNode > > const &p, std::ostream &os, bool optional, DocFormatHelper &dfh, std::string const &switchLabel)

Private Member Functions
int	howManyXORSubNodesExist_ (ParameterSet const &pset) const override
bool	partiallyExists_ (ParameterSet const &pset) const override

Static Private Member Functions
static void	printCase (std::pair< bool, edm::value_ptr< ParameterDescriptionNode > > const &p, std::ostream &os, bool optional, DocFormatHelper &dfh, std::string const &switchLabel)
static void	printCase (std::pair< int, edm::value_ptr< ParameterDescriptionNode > > const &p, std::ostream &os, bool optional, DocFormatHelper &dfh, std::string const &switchLabel)
static void	printCase (std::pair< std::string, edm::value_ptr< ParameterDescriptionNode > > const &p, std::ostream &os, bool optional, DocFormatHelper &dfh, std::string const &switchLabel)

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 16 of file ParameterSwitchBase.h.

Constructor & Destructor Documentation

edm::ParameterSwitchBase::~ParameterSwitchBase ( )

override

Definition at line 13 of file ParameterSwitchBase.cc.

References throwDuplicateCaseValues().

{ }

Member Function Documentation

bool edm::ParameterSwitchBase::hasNestedContent_ ( ) const

overrideprotectedvirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 155 of file ParameterSwitchBase.cc.

References printNestedContentBase().

Referenced by printBase().

                            {
    return true;
  }

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

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 265 of file ParameterSwitchBase.cc.

References edm::ParameterDescriptionNode::exists().

Referenced by partiallyExists_(), and printCaseT().

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

void edm::ParameterSwitchBase::insertAndCheckLabels ( std::string const &  switchLabel, std::set< std::string > &  usedLabels, std::set< std::string > &  labels  ) const

protected

Definition at line 27 of file ParameterSwitchBase.cc.

References Exception, insertAndCheckTypes(), edm::errors::LogicError, and mps_update::status.

Referenced by edm::ParameterSwitch< T >::checkAndGetLabelsAndTypes_(), and throwDuplicateCaseValues().

                                                        {

    std::pair<std::set<std::string>::iterator,bool> status = labels.insert(switchLabel);
    if(status.second == false) {
      throw Exception(errors::LogicError)
        << "The label used for the switch parameter in a ParameterSetDescription\n"
        << "must be different from the labels used in the associated cases.  The following\n"
        << "duplicate label was found: \"" << switchLabel << "\"\n";
    }
    usedLabels.insert(labels.begin(), labels.end());
  }

void edm::ParameterSwitchBase::insertAndCheckTypes ( ParameterTypes  switchType, std::set< ParameterTypes > const &  caseParameterTypes, std::set< ParameterTypes > const &  caseWildcardTypes, std::set< ParameterTypes > &  parameterTypes, std::set< ParameterTypes > &  wildcardTypes  ) const

protected

Definition at line 43 of file ParameterSwitchBase.cc.

References Exception, edm::errors::LogicError, edm::parameterTypeEnumToString(), and throwNoCaseForDefault().

Referenced by edm::ParameterSwitch< T >::checkAndGetLabelsAndTypes_(), and insertAndCheckLabels().

                                                                   {

    if(caseWildcardTypes.find(switchType) != caseWildcardTypes.end()) {
      throw Exception(errors::LogicError)
        << "The type used for the switch parameter in a ParameterSetDescription\n"
        << "must be different from the types used for wildcards in the associated cases.  The following\n"
        << "duplicate type was found: \"" << parameterTypeEnumToString(switchType) << "\"\n";
    }
    parameterTypes.insert(switchType);
    parameterTypes.insert(caseParameterTypes.begin(), caseParameterTypes.end());
    wildcardTypes.insert(caseWildcardTypes.begin(), caseWildcardTypes.end());
  }

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

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 259 of file ParameterSwitchBase.cc.

References edm::ParameterDescriptionNode::exists(), and howManyXORSubNodesExist_().

Referenced by printCase(), and printCaseT().

                                                   {
    return exists(pset);
  }

void edm::ParameterSwitchBase::printBase ( std::ostream &  os, bool  optional, bool  writeToCfi, DocFormatHelper &  dfh, std::string const &  switchLabel, bool  isTracked, std::string const &  typeString  ) const

protected

Definition at line 78 of file ParameterSwitchBase.cc.

References edm::DocFormatHelper::brief(), edm::DocFormatHelper::column1(), edm::DocFormatHelper::column2(), edm::DocFormatHelper::column3(), edm::ParameterDescriptionNode::comment(), edm::DocFormatHelper::commentWidth(), edm::DocFormatHelper::counter(), relativeConstraints::empty, hasNestedContent_(), edm::DocFormatHelper::indent(), edm::DocFormatHelper::indent2(), edm::DocFormatHelper::pass(), edm::DocFormatHelper::section(), edm::DocFormatHelper::setAtLeast1(), edm::DocFormatHelper::setAtLeast2(), edm::DocFormatHelper::setAtLeast3(), edm::DocFormatHelper::startColumn2(), mitigatedMETSequence_cff::U, and edm::DocFormatHelper::wrapAndPrintText().

Referenced by edm::ParameterSwitch< T >::print_(), and throwNoCaseForSwitchValue().

                                               {

    if(dfh.pass() == 0) {
      dfh.setAtLeast1(switchLabel.size() + 9U);
      if(isTracked) {
        dfh.setAtLeast2(typeString.size());
      } else {
        dfh.setAtLeast2(typeString.size() + 10U);
      }
      dfh.setAtLeast3(8U);
    }
    if(dfh.pass() == 1) {

      dfh.indent(os);

      if(dfh.brief()) {

        std::stringstream ss;
        ss << switchLabel << " (switch)";
        std::ios::fmtflags oldFlags = os.flags();
        os << std::left << std::setw(dfh.column1()) << ss.str();
        os << " ";

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

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

        if(!writeToCfi) os << " (do not write to cfi)";

        os << " see Section " << dfh.section() << "." << dfh.counter() << "\n";
        os.flags(oldFlags);
      } else {
        // not brief

        os << switchLabel << " (switch)\n";

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

        if(optional)  os << "optional";

        if(!writeToCfi) os << " (do not write to cfi)";
        os << "\n";

        dfh.indent2(os);
        os << "see Section " << dfh.section() << "." << dfh.counter() << "\n";

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

void edm::ParameterSwitchBase::printCase ( std::pair< bool, edm::value_ptr< ParameterDescriptionNode > > const &  p, std::ostream &  os, bool  optional, DocFormatHelper &  dfh, std::string const &  switchLabel  )

staticprivate

Definition at line 196 of file ParameterSwitchBase.cc.

References edm::DocFormatHelper::indent(), AlCaHLTBitMon_ParallelJobs::p, and edm::DocFormatHelper::pass().

Referenced by printCase(), printCaseT(), and printNestedContentBase().

                                          {
    if(dfh.pass() == 0) {
      p.second->print(os, false, true, dfh);
    }
    if(dfh.pass() == 1) {
      dfh.indent(os);
      os << "if " << switchLabel << " = ";
      if(p.first) os << "True";
      else os << "False";
      os << "\n";
      p.second->print(os, false, true, dfh);
    }
    if(dfh.pass() == 2) {
      p.second->printNestedContent(os, false, dfh);
    }
  }

void edm::ParameterSwitchBase::printCase ( std::pair< int, edm::value_ptr< ParameterDescriptionNode > > const &  p, std::ostream &  os, bool  optional, DocFormatHelper &  dfh, std::string const &  switchLabel  )

staticprivate

Definition at line 219 of file ParameterSwitchBase.cc.

References edm::DocFormatHelper::indent(), AlCaHLTBitMon_ParallelJobs::p, edm::DocFormatHelper::pass(), and printCase().

                                          {
    if(dfh.pass() == 0) {
      p.second->print(os, false, true, dfh);
    }
    if(dfh.pass() == 1) {
      dfh.indent(os);
      os << "if " << switchLabel << " = " << p.first << "\n";
      p.second->print(os, false, true, dfh);
    }
    if(dfh.pass() == 2) {
      p.second->printNestedContent(os, false, dfh);
    }
  }

void edm::ParameterSwitchBase::printCase ( std::pair< std::string, edm::value_ptr< ParameterDescriptionNode > > const &  p, std::ostream &  os, bool  optional, DocFormatHelper &  dfh, std::string const &  switchLabel  )

staticprivate

Definition at line 239 of file ParameterSwitchBase.cc.

References edm::DocFormatHelper::indent(), AlCaHLTBitMon_ParallelJobs::p, partiallyExists_(), and edm::DocFormatHelper::pass().

                                          {
    if(dfh.pass() == 0) {
      p.second->print(os, false, true, dfh);
    }
    if(dfh.pass() == 1) {
      dfh.indent(os);
      os << "if " << switchLabel << " = \"" << p.first << "\"\n";
      p.second->print(os, false, true, dfh);
    }
    if(dfh.pass() == 2) {
      p.second->printNestedContent(os, false, dfh);
    }
  }

template<typename T >

static void edm::ParameterSwitchBase::printCaseT ( std::pair< T, edm::value_ptr< ParameterDescriptionNode > > const &  p, std::ostream &  os, bool  optional, DocFormatHelper &  dfh, std::string const &  switchLabel  )

inlinestaticprotected

Definition at line 53 of file ParameterSwitchBase.h.

References howManyXORSubNodesExist_(), AlCaHLTBitMon_ParallelJobs::p, partiallyExists_(), printCase(), muonDTDigis_cfi::pset, and AlCaHLTBitMon_QueryRunRegistry::string.

                                                         {
      ParameterSwitchBase::printCase(p, os, optional, dfh, switchLabel);
    }

void edm::ParameterSwitchBase::printNestedContentBase ( std::ostream &  os, DocFormatHelper &  dfh, DocFormatHelper &  new_dfh, std::string const &  switchLabel  ) const

protected

Definition at line 161 of file ParameterSwitchBase.cc.

References edm::DocFormatHelper::brief(), edm::DocFormatHelper::counter(), edm::DocFormatHelper::indentation(), edm::DocFormatHelper::init(), edm::DocFormatHelper::offsetSectionContent(), edm::DocFormatHelper::OTHER, edm::DocFormatHelper::parent(), printCase(), edm::ParameterDescriptionNode::printSpaces(), edm::DocFormatHelper::section(), edm::DocFormatHelper::setIndentation(), edm::DocFormatHelper::setParent(), edm::DocFormatHelper::setSection(), AlCaHLTBitMon_QueryRunRegistry::string, and edm::DocFormatHelper::TOP.

Referenced by hasNestedContent_(), and edm::ParameterSwitch< T >::printNestedContent_().

                                                             {

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

    std::stringstream ss;
    ss << dfh.section() << "." << dfh.counter();
    std::string newSection = ss.str();

    printSpaces(os, indentation);
    os << "Section " << newSection
       << " " << switchLabel << " (switch):\n";

    if(!dfh.brief()) {
      printSpaces(os, indentation);
      os << "The value of \"" << switchLabel << "\" controls which other parameters\n";
      printSpaces(os, indentation);
      os << "are required or allowed to be in the PSet.\n";
    }
    if(!dfh.brief()) os << "\n";

    new_dfh.init();
    new_dfh.setSection(newSection);
    new_dfh.setIndentation(indentation + DocFormatHelper::offsetSectionContent());
    new_dfh.setParent(DocFormatHelper::OTHER);
  }

void edm::ParameterSwitchBase::throwDuplicateCaseValues ( std::string const &  switchLabel ) const

protected

Definition at line 17 of file ParameterSwitchBase.cc.

References Exception, insertAndCheckLabels(), and edm::errors::LogicError.

Referenced by edm::ParameterSwitch< T >::ParameterSwitch(), and ~ParameterSwitchBase().

                                                               {
    throw Exception(errors::LogicError)
      << "When adding a ParameterSwitch to a ParameterSetDescription the values\n"
      << "associated with the different cases must be unique.  Duplicate\n"
      << "values were found for the switch with label: \"" << switchLabel
      << "\"\n";
  }

void edm::ParameterSwitchBase::throwNoCaseForDefault ( std::string const &  switchLabel ) const

protected

Definition at line 62 of file ParameterSwitchBase.cc.

References Exception, edm::errors::LogicError, and throwNoCaseForSwitchValue().

Referenced by edm::ParameterSwitch< T >::checkAndGetLabelsAndTypes_(), and insertAndCheckTypes().

                                                            {
    throw Exception(errors::LogicError)
      << "The default value used for the switch parameter in a ParameterSetDescription\n"
      << "must match the value used to select one of the associated cases.  This is not\n"
      << "true for the switch named \"" << switchLabel << "\"\n";
  }

void edm::ParameterSwitchBase::throwNoCaseForSwitchValue ( std::string const &  message ) const

protected

Definition at line 71 of file ParameterSwitchBase.cc.

References edm::errors::Configuration, Exception, and printBase().

Referenced by throwNoCaseForDefault(), and edm::ParameterSwitch< T >::validate_().

                                                            {
    throw Exception(errors::Configuration)
      << message;
  }