edm::ORGroupDescription Class Reference

#include <ORGroupDescription.h>

Inheritance diagram for edm::ORGroupDescription:

Public Member Functions
ParameterDescriptionNode *	clone () const override
	ORGroupDescription (ParameterDescriptionNode const &node_left, ParameterDescriptionNode const &node_right)
	ORGroupDescription (std::unique_ptr< ParameterDescriptionNode > node_left, ParameterDescriptionNode const &node_right)
	ORGroupDescription (ParameterDescriptionNode const &node_left, std::unique_ptr< ParameterDescriptionNode > node_right)
	ORGroupDescription (std::unique_ptr< ParameterDescriptionNode > node_left, std::unique_ptr< ParameterDescriptionNode > node_right)
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 (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 ()

Private Member Functions
void	checkAndGetLabelsAndTypes_ (std::set< std::string > &usedLabels, std::set< ParameterTypes > &parameterTypes, std::set< ParameterTypes > &wildcardTypes) const override
bool	exists_ (ParameterSet const &pset) const override
bool	hasNestedContent_ () 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	printNestedContent_ (std::ostream &os, bool optional, DocFormatHelper &dfh) const override
void	throwIfDuplicateLabels (std::set< std::string > const &labelsLeft, std::set< std::string > const &labelsRight) const
void	throwIfDuplicateTypes (std::set< ParameterTypes > const &types1, std::set< ParameterTypes > const &types2) const
void	validate_ (ParameterSet &pset, std::set< std::string > &validatedLabels, bool optional) const override
void	writeCfi_ (std::ostream &os, bool optional, bool &startWithComma, int indentation, bool &wroteSomething) const override

Private Attributes
edm::value_ptr < ParameterDescriptionNode >	node_left_
edm::value_ptr < ParameterDescriptionNode >	node_right_

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 18 of file ORGroupDescription.h.

Constructor & Destructor Documentation

edm::ORGroupDescription::ORGroupDescription	(	ParameterDescriptionNode const &	node_left,
		ParameterDescriptionNode const &	node_right
	)

Definition at line 13 of file ORGroupDescription.cc.

Referenced by clone().

      : node_left_(node_left.clone()), node_right_(node_right.clone()) {}

edm::ORGroupDescription::ORGroupDescription	(	std::unique_ptr< ParameterDescriptionNode >	node_left,
		ParameterDescriptionNode const &	node_right
	)

Definition at line 17 of file ORGroupDescription.cc.

      : node_left_(std::move(node_left)), node_right_(node_right.clone()) {}

edm::ORGroupDescription::ORGroupDescription	(	ParameterDescriptionNode const &	node_left,
		std::unique_ptr< ParameterDescriptionNode >	node_right
	)

Definition at line 21 of file ORGroupDescription.cc.

      : node_left_(node_left.clone()), node_right_(std::move(node_right)) {}

edm::ORGroupDescription::ORGroupDescription	(	std::unique_ptr< ParameterDescriptionNode >	node_left,
		std::unique_ptr< ParameterDescriptionNode >	node_right
	)

Definition at line 25 of file ORGroupDescription.cc.

      : node_left_(std::move(node_left)), node_right_(std::move(node_right)) {}

Member Function Documentation

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

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 29 of file ORGroupDescription.cc.

References node_left_, node_right_, throwIfDuplicateLabels(), and throwIfDuplicateTypes().

                                                                                                   {
    std::set<std::string> labelsLeft;
    std::set<ParameterTypes> parameterTypesLeft;
    std::set<ParameterTypes> wildcardTypesLeft;
    node_left_->checkAndGetLabelsAndTypes(labelsLeft, parameterTypesLeft, wildcardTypesLeft);

    std::set<std::string> labelsRight;
    std::set<ParameterTypes> parameterTypesRight;
    std::set<ParameterTypes> wildcardTypesRight;
    node_right_->checkAndGetLabelsAndTypes(labelsRight, parameterTypesRight, wildcardTypesRight);

    throwIfDuplicateLabels(labelsLeft, labelsRight);
    throwIfDuplicateTypes(wildcardTypesLeft, parameterTypesRight);
    throwIfDuplicateTypes(wildcardTypesRight, parameterTypesLeft);

    usedLabels.insert(labelsLeft.begin(), labelsLeft.end());
    usedLabels.insert(labelsRight.begin(), labelsRight.end());

    parameterTypes.insert(parameterTypesRight.begin(), parameterTypesRight.end());
    parameterTypes.insert(parameterTypesLeft.begin(), parameterTypesLeft.end());

    wildcardTypes.insert(wildcardTypesRight.begin(), wildcardTypesRight.end());
    wildcardTypes.insert(wildcardTypesLeft.begin(), wildcardTypesLeft.end());
  }

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

inlineoverridevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 29 of file ORGroupDescription.h.

References ORGroupDescription().

{ return new ORGroupDescription(*this); }

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

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 177 of file ORGroupDescription.cc.

References node_left_, and node_right_.

                                                                 {
    return node_left_->exists(pset) || node_right_->exists(pset);
  }

bool edm::ORGroupDescription::hasNestedContent_ ( ) const

inlineoverrideprivatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 43 of file ORGroupDescription.h.

{ return true; }

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

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 183 of file ORGroupDescription.cc.

References edm::ParameterDescriptionNode::exists().

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

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

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 181 of file ORGroupDescription.cc.

References edm::ParameterDescriptionNode::exists().

{ return exists(pset); }

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

overrideprivatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 79 of file ORGroupDescription.cc.

References edm::DocFormatHelper::brief(), edm::ParameterDescriptionNode::comment(), edm::DocFormatHelper::commentWidth(), edm::DocFormatHelper::counter(), edm::DocFormatHelper::decrementCounter(), relativeConstraints::empty, edm::DocFormatHelper::indent(), edm::DocFormatHelper::indent2(), node_left_, node_right_, edm::DocFormatHelper::OR, edm::DocFormatHelper::parent(), edm::DocFormatHelper::pass(), edm::DocFormatHelper::section(), edm::DocFormatHelper::startColumn2(), and edm::DocFormatHelper::wrapAndPrintText().

                                                                                                            {
    if (dfh.parent() == DocFormatHelper::OR) {
      dfh.decrementCounter();
      node_left_->print(os, false, true, dfh);
      node_right_->print(os, false, true, dfh);
      return;
    }

    if (dfh.pass() == 1) {
      dfh.indent(os);
      os << "OR group:";

      if (dfh.brief()) {
        if (optional)
          os << " optional";

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

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

        if (optional)
          os << "optional";
        if (!writeToCfi)
          os << " (do not write to cfi)";
        if (optional || !writeToCfi) {
          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::ORGroupDescription::printNestedContent_ ( std::ostream &  os, bool  optional, DocFormatHelper &  dfh  ) const

overrideprivatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 124 of file ORGroupDescription.cc.

References edm::DocFormatHelper::brief(), edm::DocFormatHelper::counter(), edm::DocFormatHelper::decrementCounter(), edm::DocFormatHelper::indentation(), edm::DocFormatHelper::init(), node_left_, node_right_, edm::DocFormatHelper::offsetSectionContent(), edm::DocFormatHelper::OR, edm::DocFormatHelper::parent(), edm::ParameterDescriptionNode::printSpaces(), edm::DocFormatHelper::section(), edm::DocFormatHelper::setCounter(), edm::DocFormatHelper::setIndentation(), edm::DocFormatHelper::setParent(), edm::DocFormatHelper::setPass(), edm::DocFormatHelper::setSection(), contentValuesCheck::ss, AlCaHLTBitMon_QueryRunRegistry::string, and edm::DocFormatHelper::TOP.

                                                                                                        {
    if (dfh.parent() == DocFormatHelper::OR) {
      dfh.decrementCounter();
      node_left_->printNestedContent(os, false, dfh);
      node_right_->printNestedContent(os, false, dfh);
      return;
    }

    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 << " OR group description:\n";
    printSpaces(os, indentation);
    if (optional) {
      // An optional OR group is kind of pointless, it would be
      // easier just make the parameters be independent optional parameters
      // I only allow it to make the behavior analogous to the other groups
      os << "This optional OR group requires at least one or none of the following to be in the PSet\n";
    } else {
      os << "This OR group requires at least one of the following to be in the PSet\n";
    }
    if (!dfh.brief())
      os << "\n";

    DocFormatHelper new_dfh(dfh);
    new_dfh.init();
    new_dfh.setSection(newSection);
    new_dfh.setIndentation(indentation + DocFormatHelper::offsetSectionContent());
    new_dfh.setParent(DocFormatHelper::OR);

    node_left_->print(os, false, true, new_dfh);
    node_right_->print(os, false, true, new_dfh);

    new_dfh.setPass(1);
    new_dfh.setCounter(0);

    node_left_->print(os, false, true, new_dfh);
    node_right_->print(os, false, true, new_dfh);

    new_dfh.setPass(2);
    new_dfh.setCounter(0);

    node_left_->printNestedContent(os, false, new_dfh);
    node_right_->printNestedContent(os, false, new_dfh);
  }

void edm::ORGroupDescription::throwIfDuplicateLabels ( std::set< std::string > const &  labelsLeft, std::set< std::string > const &  labelsRight  ) const

private

Definition at line 185 of file ORGroupDescription.cc.

References Exception, edm::errors::LogicError, DBoxMetadataHelper::set_intersection(), and contentValuesCheck::ss.

Referenced by checkAndGetLabelsAndTypes_().

                                                                                              {
    std::set<std::string> duplicateLabels;
    std::insert_iterator<std::set<std::string> > insertIter(duplicateLabels, duplicateLabels.begin());
    std::set_intersection(labelsLeft.begin(), labelsLeft.end(), labelsRight.begin(), labelsRight.end(), insertIter);
    if (!duplicateLabels.empty()) {
      std::stringstream ss;
      for (std::set<std::string>::const_iterator iter = duplicateLabels.begin(), iEnd = duplicateLabels.end();
           iter != iEnd;
           ++iter) {
        ss << " \"" << *iter << "\"\n";
      }
      throw edm::Exception(errors::LogicError) << "Labels used in a node of a ParameterSetDescription\n"
                                               << "\"or\" expression must be not be the same as labels used\n"
                                               << "in other nodes of the expression.  The following duplicate\n"
                                               << "labels were detected:\n"
                                               << ss.str() << "\n";
    }
  }

void edm::ORGroupDescription::throwIfDuplicateTypes ( std::set< ParameterTypes > const &  types1, std::set< ParameterTypes > const &  types2  ) const

private

Definition at line 205 of file ORGroupDescription.cc.

References Exception, edm::errors::LogicError, edm::parameterTypeEnumToString(), DBoxMetadataHelper::set_intersection(), and contentValuesCheck::ss.

Referenced by checkAndGetLabelsAndTypes_().

                                                                                             {
    if (!types1.empty()) {
      std::set<ParameterTypes> duplicateTypes;
      std::insert_iterator<std::set<ParameterTypes> > insertIter(duplicateTypes, duplicateTypes.begin());
      std::set_intersection(types1.begin(), types1.end(), types2.begin(), types2.end(), insertIter);
      if (!duplicateTypes.empty()) {
        std::stringstream ss;
        for (std::set<ParameterTypes>::const_iterator iter = duplicateTypes.begin(), iEnd = duplicateTypes.end();
             iter != iEnd;
             ++iter) {
          ss << " \"" << parameterTypeEnumToString(*iter) << "\"\n";
        }
        throw edm::Exception(errors::LogicError)
            << "Types used for wildcards in a node of a ParameterSetDescription\n"
            << "\"or\" expression must be different from types used for other parameters\n"
            << "in other nodes.  The following duplicate types were detected:\n"
            << ss.str() << "\n";
      }
    }
  }

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

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 56 of file ORGroupDescription.cc.

References node_left_, and node_right_.

                                                                                                                {
    bool leftExists = node_left_->exists(pset);
    bool rightExists = node_right_->exists(pset);

    if (leftExists || rightExists) {
      if (leftExists)
        node_left_->validate(pset, validatedLabels, false);
      if (rightExists)
        node_right_->validate(pset, validatedLabels, false);
      return;
    }

    if (optional)
      return;

    node_left_->validate(pset, validatedLabels, false);
  }

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

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 74 of file ORGroupDescription.cc.

References node_left_.

                                                                                                        {
    node_left_->writeCfi(os, optional, startWithComma, indentation, wroteSomething);
  }

Member Data Documentation

edm::value_ptr<ParameterDescriptionNode> edm::ORGroupDescription::node_left_

private

Definition at line 58 of file ORGroupDescription.h.

Referenced by checkAndGetLabelsAndTypes_(), exists_(), print_(), printNestedContent_(), validate_(), and writeCfi_().

edm::value_ptr<ParameterDescriptionNode> edm::ORGroupDescription::node_right_

private

Definition at line 59 of file ORGroupDescription.h.

Referenced by checkAndGetLabelsAndTypes_(), exists_(), print_(), printNestedContent_(), and validate_().