edm::XORGroupDescription Class Reference

#include <XORGroupDescription.h>

Inheritance diagram for edm::XORGroupDescription:

Public Member Functions
ParameterDescriptionNode *	clone () const override
	XORGroupDescription (ParameterDescriptionNode const &node_left, ParameterDescriptionNode const &node_right)
	XORGroupDescription (std::unique_ptr< ParameterDescriptionNode > node_left, ParameterDescriptionNode const &node_right)
	XORGroupDescription (ParameterDescriptionNode const &node_left, std::unique_ptr< ParameterDescriptionNode > node_right)
	XORGroupDescription (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
virtual bool	isWildcard () 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	throwAfterValidation () const
void	throwMoreThanOneParameter () 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 XORGroupDescription.h.

Constructor & Destructor Documentation

XORGroupDescription() [1/4]

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

Definition at line 11 of file XORGroupDescription.cc.

Referenced by clone().

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

XORGroupDescription() [2/4]

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

Definition at line 15 of file XORGroupDescription.cc.

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

XORGroupDescription() [3/4]

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

Definition at line 19 of file XORGroupDescription.cc.

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

XORGroupDescription() [4/4]

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

Definition at line 23 of file XORGroupDescription.cc.

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

Member Function Documentation

checkAndGetLabelsAndTypes_()

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

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 27 of file XORGroupDescription.cc.

References node_left_, and node_right_.

                                                                                                    {
    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);

    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());
  }

clone()

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

inlineoverridevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 31 of file XORGroupDescription.h.

References XORGroupDescription().

{ return new XORGroupDescription(*this); }

exists_()

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

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 181 of file XORGroupDescription.cc.

References node_left_, node_right_, and muonDTDigis_cfi::pset.

                                                                  {
    int nTotal = node_left_->howManyXORSubNodesExist(pset) + node_right_->howManyXORSubNodesExist(pset);
    return nTotal == 1;
  }

hasNestedContent_()

bool edm::XORGroupDescription::hasNestedContent_ ( ) const

inlineoverrideprivatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 45 of file XORGroupDescription.h.

{ return true; }

howManyXORSubNodesExist_()

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

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 188 of file XORGroupDescription.cc.

References node_left_, node_right_, and muonDTDigis_cfi::pset.

                                                                                  {
    return node_left_->howManyXORSubNodesExist(pset) + node_right_->howManyXORSubNodesExist(pset);
  }

partiallyExists_()

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

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 186 of file XORGroupDescription.cc.

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

{ return exists(pset); }

print_()

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

overrideprivatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 86 of file XORGroupDescription.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_, Types::optional, edm::DocFormatHelper::parent(), edm::DocFormatHelper::pass(), edm::DocFormatHelper::section(), edm::DocFormatHelper::startColumn2(), edm::DocFormatHelper::wrapAndPrintText(), and edm::DocFormatHelper::XOR.

                                                                                                             {
    if (dfh.parent() == DocFormatHelper::XOR) {
      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 << "XOR 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";
      }
    }
  }

printNestedContent_()

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

overrideprivatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 131 of file XORGroupDescription.cc.

References edm::DocFormatHelper::brief(), edm::DocFormatHelper::counter(), edm::DocFormatHelper::decrementCounter(), printContent_cfi::indentation, edm::DocFormatHelper::indentation(), edm::DocFormatHelper::init(), node_left_, node_right_, edm::DocFormatHelper::offsetSectionContent(), Types::optional, 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, edm::DocFormatHelper::TOP, and edm::DocFormatHelper::XOR.

                                                                                                         {
    if (dfh.parent() == DocFormatHelper::XOR) {
      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 << " XOR group description:\n";
    printSpaces(os, indentation);
    if (optional) {
      os << "This optional XOR group requires exactly one or none of the following to be in the PSet\n";
    } else {
      os << "This XOR group requires exactly 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::XOR);

    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);
  }

throwAfterValidation()

void edm::XORGroupDescription::throwAfterValidation ( ) const

private

Definition at line 204 of file XORGroupDescription.cc.

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

Referenced by validate_().

                                                       {
    // Need to expand this error message to print more information
    // I guess I need to print out the entire node structure of
    // of the xor node and all the nodes it contains.
    throw edm::Exception(errors::LogicError)
        << "Exactly one parameter can exist in a ParameterSet from a list of\n"
        << "parameters described by an \"xor\" operator in a ParameterSetDescription.\n"
        << "This rule also applies in a more general sense to the other types\n"
        << "of nodes that can appear within a ParameterSetDescription.  Only one\n"
        << "can pass validation as \"existing\".  This error has occurred after an\n"
        << "attempt to insert missing parameters to fix the problem.\n";
  }

throwMoreThanOneParameter()

void edm::XORGroupDescription::throwMoreThanOneParameter ( ) const

private

Definition at line 192 of file XORGroupDescription.cc.

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

Referenced by validate_().

                                                            {
    // Need to expand this error message to print more information
    // I guess I need to print out the entire node structure of
    // of the xor node and all the nodes it contains.
    throw edm::Exception(errors::LogicError)
        << "Exactly one parameter can exist in a ParameterSet from a list of\n"
        << "parameters described by an \"xor\" operator in a ParameterSetDescription.\n"
        << "This rule also applies in a more general sense to the other types\n"
        << "of nodes that can appear within a ParameterSetDescription.  Only one\n"
        << "can pass validation as \"existing\".\n";
  }

validate_()

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

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 50 of file XORGroupDescription.cc.

References node_left_, node_right_, Types::optional, muonDTDigis_cfi::pset, throwAfterValidation(), and throwMoreThanOneParameter().

                                                                                                                 {
    int nExistLeft = node_left_->howManyXORSubNodesExist(pset);
    int nExistRight = node_right_->howManyXORSubNodesExist(pset);
    int nTotal = nExistLeft + nExistRight;

    if (nTotal == 0 && optional)
      return;

    if (nTotal > 1) {
      throwMoreThanOneParameter();
    }

    if (nExistLeft == 1) {
      node_left_->validate(pset, validatedLabels, false);
    } else if (nExistRight == 1) {
      node_right_->validate(pset, validatedLabels, false);
    } else if (nTotal == 0) {
      node_left_->validate(pset, validatedLabels, false);

      // When missing parameters get inserted, both nodes could
      // be affected so we have to recheck both nodes.
      nExistLeft = node_left_->howManyXORSubNodesExist(pset);
      nExistRight = node_right_->howManyXORSubNodesExist(pset);
      nTotal = nExistLeft + nExistRight;

      if (nTotal != 1) {
        throwAfterValidation();
      }
    }
  }

writeCfi_()

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

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 81 of file XORGroupDescription.cc.

References printContent_cfi::indentation, node_left_, and Types::optional.

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

Member Data Documentation

node_left_

edm::value_ptr<ParameterDescriptionNode> edm::XORGroupDescription::node_left_

private

Definition at line 58 of file XORGroupDescription.h.

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

node_right_

edm::value_ptr<ParameterDescriptionNode> edm::XORGroupDescription::node_right_

private

Definition at line 59 of file XORGroupDescription.h.

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