edm::ParameterDescription< ParameterSetDescription > Class Template Reference

#include <ParameterDescription.h>

Inheritance diagram for edm::ParameterDescription< ParameterSetDescription >:

Public Member Functions
ParameterDescriptionNode *	clone () const override
	ParameterDescription (std::string const &iLabel, ParameterSetDescription const &value, bool isTracked, Comment const &iComment=Comment())
	ParameterDescription (char const *iLabel, ParameterSetDescription const &value, bool isTracked, Comment const &iComment=Comment())
ParameterSetDescription const *	parameterSetDescription () const override
ParameterSetDescription *	parameterSetDescription () override
	~ParameterDescription () override
Public Member Functions inherited from edm::ParameterDescriptionBase
bool	hasDefault () const
bool	isTracked () const
std::string const &	label () const
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
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 ()

Private Member Functions
bool	exists_ (ParameterSet const &pset) const override
bool	exists_ (ParameterSet const &pset, bool isTracked) const override
bool	hasNestedContent_ () const override
void	insertDefault_ (ParameterSet &pset) const override
void	printDefault_ (std::ostream &os, bool writeToCfi, DocFormatHelper &dfh) const override
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, int indentation) const override
void	writeDoc_ (std::ostream &os, int indentation) const override

Private Attributes
value_ptr< ParameterSetDescription >	psetDesc_

Additional Inherited Members
Static Public Member Functions inherited from edm::ParameterDescriptionNode
static void	printSpaces (std::ostream &os, int n)
Protected Member Functions inherited from edm::ParameterDescriptionBase
	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 Attributes inherited from edm::ParameterDescriptionNode
std::string	comment_

Detailed Description

template<>
class edm::ParameterDescription< ParameterSetDescription >

Definition at line 194 of file ParameterDescription.h.

Constructor & Destructor Documentation

edm::ParameterDescription< ParameterSetDescription >::ParameterDescription	(	std::string const &	iLabel,
		ParameterSetDescription const &	value,
		bool	isTracked,
		Comment const &	iComment = Comment()
	)

Definition at line 27 of file ParameterDescription.cc.

      : ParameterDescriptionBase(iLabel, k_PSet, isTracked, true, iComment),
        psetDesc_(new ParameterSetDescription(value)) {}

edm::ParameterDescription< ParameterSetDescription >::ParameterDescription	(	char const *	iLabel,
		ParameterSetDescription const &	value,
		bool	isTracked,
		Comment const &	iComment = Comment()
	)

Definition at line 34 of file ParameterDescription.cc.

      : ParameterDescriptionBase(iLabel, k_PSet, isTracked, true, iComment),
        psetDesc_(new ParameterSetDescription(value)) {}

edm::ParameterDescription< ParameterSetDescription >::~ParameterDescription ( )

override

Definition at line 41 of file ParameterDescription.cc.

{}

Member Function Documentation

ParameterDescriptionNode* edm::ParameterDescription< ParameterSetDescription >::clone ( void  ) const

inlineoverridevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 211 of file ParameterDescription.h.

References muonDTDigis_cfi::pset.

{ return new ParameterDescription(*this); }

bool edm::ParameterDescription< ParameterSetDescription >::exists_ ( ParameterSet const &  pset ) const

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 113 of file ParameterDescription.cc.

References edm::ParameterSet::existsAs(), edm::ParameterDescriptionBase::isTracked(), and edm::ParameterDescriptionBase::label().

                                                                                            {
    return pset.existsAs<ParameterSet>(label(), isTracked());
  }

bool edm::ParameterDescription< ParameterSetDescription >::exists_ ( ParameterSet const &  pset, bool  isTracked  ) const

overrideprivatevirtual

Implements edm::ParameterDescriptionBase.

Definition at line 134 of file ParameterDescription.cc.

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

                                                                                               {
    throw Exception(errors::LogicError);
    return true;
  }

bool edm::ParameterDescription< ParameterSetDescription >::hasNestedContent_ ( ) const

overrideprivatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 85 of file ParameterDescription.cc.

{ return true; }

void edm::ParameterDescription< ParameterSetDescription >::insertDefault_ ( ParameterSet &  pset ) const

overrideprivatevirtual

Implements edm::ParameterDescriptionBase.

Definition at line 139 of file ParameterDescription.cc.

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

                                                                                        {
    throw Exception(errors::LogicError);
    return;
  }

ParameterSetDescription const * edm::ParameterDescription< ParameterSetDescription >::parameterSetDescription ( ) const

overridevirtual

Reimplemented from edm::ParameterDescriptionBase.

Definition at line 117 of file ParameterDescription.cc.

                                                                                                              {
    return psetDesc_.operator->();
  }

ParameterSetDescription * edm::ParameterDescription< ParameterSetDescription >::parameterSetDescription ( )

overridevirtual

Reimplemented from edm::ParameterDescriptionBase.

Definition at line 121 of file ParameterDescription.cc.

                                                                                                  {
    return psetDesc_.operator->();
  }

void edm::ParameterDescription< ParameterSetDescription >::printDefault_ ( std::ostream &  os, bool  writeToCfi, DocFormatHelper &  dfh  ) const

overrideprivatevirtual

Reimplemented from edm::ParameterDescriptionBase.

Definition at line 76 of file ParameterDescription.cc.

References edm::DocFormatHelper::counter(), and edm::DocFormatHelper::section().

                                                                                                {
    os << "see Section " << dfh.section() << "." << dfh.counter();
    if (!writeToCfi)
      os << " (do not write to cfi)";
    os << "\n";
  }

void edm::ParameterDescription< ParameterSetDescription >::printNestedContent_ ( std::ostream &  os, bool  optional, DocFormatHelper &  dfh  ) const

overrideprivatevirtual

Reimplemented from edm::ParameterDescriptionNode.

Definition at line 87 of file ParameterDescription.cc.

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

                                                                                                      {
    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 << " " << label() << " PSet description:\n";
    if (!dfh.brief())
      os << "\n";

    DocFormatHelper new_dfh(dfh);
    new_dfh.init();
    new_dfh.setSection(newSection);
    if (dfh.parent() == DocFormatHelper::TOP) {
      new_dfh.setIndentation(indentation + DocFormatHelper::offsetSectionContent());
    }
    psetDesc_->print(os, new_dfh);
  }

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

overrideprivatevirtual

Implements edm::ParameterDescriptionNode.

Definition at line 43 of file ParameterDescription.cc.

References edm::ParameterSet::addParameter(), edm::ParameterSet::addUntrackedParameter(), edm::ParameterDescriptionNode::exists(), edm::ParameterSet::exists(), edm::ParameterSet::existsAs(), edm::ParameterSet::getPSetForUpdate(), edm::ParameterSet::insert(), edm::ParameterSet::invalidateRegistration(), edm::ParameterSet::isRegistered(), edm::ParameterDescriptionBase::isTracked(), edm::ParameterDescriptionBase::label(), edm::ParameterDescriptionBase::throwParameterWrongTrackiness(), and edm::ParameterDescriptionBase::throwParameterWrongType().

                                                                                     {
    bool exists = pset.existsAs<ParameterSet>(label(), isTracked());

    if (exists) {
      validatedLabels.insert(label());
    } else if (pset.existsAs<ParameterSet>(label(), !isTracked())) {
      throwParameterWrongTrackiness();
    } else if (pset.exists(label())) {
      throwParameterWrongType();
    }

    if (!optional && !exists) {
      if (isTracked()) {
        pset.addParameter(label(), ParameterSet());
      } else {
        pset.addUntrackedParameter(label(), ParameterSet());
      }
      validatedLabels.insert(label());
    }

    exists = pset.existsAs<ParameterSet>(label(), isTracked());

    if (exists) {
      if (pset.isRegistered()) {
        pset.invalidateRegistration("");
      }
      ParameterSet* containedPSet = pset.getPSetForUpdate(label());
      psetDesc_->validate(*containedPSet);
    }
  }

void edm::ParameterDescription< ParameterSetDescription >::writeCfi_ ( std::ostream &  os, int  indentation  ) const

overrideprivatevirtual

Implements edm::ParameterDescriptionBase.

Definition at line 125 of file ParameterDescription.cc.

                                                                                                     {
    bool startWithComma = false;
    indentation += 2;
    psetDesc_->writeCfi(os, startWithComma, indentation);
  }

void edm::ParameterDescription< ParameterSetDescription >::writeDoc_ ( std::ostream &  os, int  indentation  ) const

overrideprivatevirtual

Implements edm::ParameterDescriptionBase.

Definition at line 131 of file ParameterDescription.cc.

{}

Member Data Documentation

value_ptr<ParameterSetDescription> edm::ParameterDescription< ParameterSetDescription >::psetDesc_

private

Definition at line 232 of file ParameterDescription.h.