edm::ParameterDescriptionNode Class Reference

#include <ParameterDescriptionNode.h>

Inheritance diagram for edm::ParameterDescriptionNode:

Public Member Functions
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 optional, bool &startWithComma, int indentation, bool &wroteSomething) const
virtual	~ParameterDescriptionNode ()

Static Public Member Functions
static void	printSpaces (std::ostream &os, int n)

Protected Member Functions
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 bool	hasNestedContent_ () const
virtual int	howManyXORSubNodesExist_ (ParameterSet const &pset) const =0
virtual bool	partiallyExists_ (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 optional, bool &startWithComma, int indentation, bool &wroteSomething) const =0

Protected Attributes
std::string	comment_

Detailed Description

Definition at line 84 of file ParameterDescriptionNode.h.

Constructor & Destructor Documentation

ParameterDescriptionNode() [1/2]

edm::ParameterDescriptionNode::ParameterDescriptionNode ( )

inline

Definition at line 86 of file ParameterDescriptionNode.h.

{}

ParameterDescriptionNode() [2/2]

edm::ParameterDescriptionNode::ParameterDescriptionNode ( Comment const &  iComment )

inlineexplicit

Definition at line 88 of file ParameterDescriptionNode.h.

: comment_(iComment.comment()) {}

~ParameterDescriptionNode()

edm::ParameterDescriptionNode::~ParameterDescriptionNode ( )

virtual

Definition at line 107 of file ParameterDescriptionNode.cc.

{}

Member Function Documentation

checkAndGetLabelsAndTypes()

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

inline

Definition at line 209 of file ParameterDescriptionNode.h.

References checkAndGetLabelsAndTypes_().

Referenced by edm::ParameterSetDescription::addNode(), and edm::AllowedLabelsDescriptionBase::checkAndGetLabelsAndTypes_().

                                                                                {
      checkAndGetLabelsAndTypes_(usedLabels, parameterTypes, wildcardTypes);
    }

checkAndGetLabelsAndTypes_()

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

protectedpure virtual

Implemented in edm::PluginDescription< T >, edm::ParameterDescriptionBase, edm::ParameterSwitch< T >, edm::ParameterWildcardBase, edm::IfExistsDescription, edm::ANDGroupDescription, edm::XORGroupDescription, edm::ORGroupDescription, edm::AllowedLabelsDescriptionBase, and edm::EmptyGroupDescription.

Referenced by checkAndGetLabelsAndTypes().

clone()

virtual ParameterDescriptionNode* edm::ParameterDescriptionNode::clone ( ) const

pure virtual

Implemented in edm::ParameterDescription< std::vector< ParameterSet > >, edm::ParameterDescription< ParameterSetDescription >, edm::ParameterDescription< T >, edm::ParameterDescription< std::vector< std::string > >, edm::PluginDescription< T >, edm::ParameterWildcard< std::vector< ParameterSet > >, edm::AllowedLabelsDescription< std::vector< ParameterSet > >, edm::ParameterWildcard< ParameterSetDescription >, edm::AllowedLabelsDescription< ParameterSetDescription >, edm::ParameterSwitch< T >, edm::ParameterWildcard< T >, edm::AllowedLabelsDescription< T >, edm::IfExistsDescription, edm::ANDGroupDescription, edm::XORGroupDescription, edm::ORGroupDescription, edm::ParameterWildcardWithSpecifics, and edm::EmptyGroupDescription.

Referenced by edm::ParameterSetDescription::addNode(), edm::ParameterSetDescription::addOptionalNode(), and edm::operator>>().

comment()

std::string const& edm::ParameterDescriptionNode::comment ( ) const

inline

Definition at line 94 of file ParameterDescriptionNode.h.

References comment_.

Referenced by edm::AllowedLabelsDescriptionBase::print_(), edm::ORGroupDescription::print_(), edm::XORGroupDescription::print_(), edm::ANDGroupDescription::print_(), edm::IfExistsDescription::print_(), edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::print_(), and edm::ParameterSwitchBase::printBase().

{ return comment_; }

exists()

bool edm::ParameterDescriptionNode::exists ( ParameterSet const &  pset ) const

inline

Definition at line 136 of file ParameterDescriptionNode.h.

References exists_(), and muonDTDigis_cfi::pset.

Referenced by edm::AllowedLabelsDescriptionBase::exists_(), edm::EmptyGroupDescription::howManyXORSubNodesExist_(), edm::ParameterWildcardBase::howManyXORSubNodesExist_(), edm::AllowedLabelsDescriptionBase::howManyXORSubNodesExist_(), edm::ORGroupDescription::howManyXORSubNodesExist_(), edm::IfExistsDescription::howManyXORSubNodesExist_(), edm::ANDGroupDescription::howManyXORSubNodesExist_(), edm::ParameterDescriptionBase::howManyXORSubNodesExist_(), edm::ParameterSwitchBase::howManyXORSubNodesExist_(), edm::PluginDescription< T >::howManyXORSubNodesExist_(), edm::EmptyGroupDescription::partiallyExists_(), edm::ParameterWildcardBase::partiallyExists_(), edm::AllowedLabelsDescriptionBase::partiallyExists_(), edm::ORGroupDescription::partiallyExists_(), edm::XORGroupDescription::partiallyExists_(), edm::IfExistsDescription::partiallyExists_(), edm::ParameterDescriptionBase::partiallyExists_(), edm::ParameterSwitchBase::partiallyExists_(), edm::AllowedLabelsDescriptionBase::validate_(), edm::ParameterDescriptionBase::validate_(), and edm::ParameterDescription< ParameterSetDescription >::validate_().

{ return exists_(pset); }

exists_()

virtual bool edm::ParameterDescriptionNode::exists_ ( ParameterSet const &  pset ) const

protectedpure virtual

Implemented in edm::ParameterDescription< std::vector< ParameterSet > >, edm::ParameterDescription< ParameterSetDescription >, edm::PluginDescription< T >, edm::ParameterDescription< T >, edm::ParameterDescription< std::vector< std::string > >, edm::ParameterSwitch< T >, edm::ParameterWildcard< std::vector< ParameterSet > >, edm::ParameterWildcard< ParameterSetDescription >, edm::IfExistsDescription, edm::ANDGroupDescription, edm::XORGroupDescription, edm::ORGroupDescription, edm::AllowedLabelsDescriptionBase, edm::ParameterWildcard< T >, edm::EmptyGroupDescription, and edm::ParameterWildcardWithSpecifics.

Referenced by exists().

hasNestedContent()

bool edm::ParameterDescriptionNode::hasNestedContent ( ) const

inline

Definition at line 125 of file ParameterDescriptionNode.h.

References hasNestedContent_().

Referenced by print(), edm::ParameterWildcardBase::print_(), edm::ParameterDescriptionBase::printDefault_(), and printNestedContent().

{ return hasNestedContent_(); }

hasNestedContent_()

virtual bool edm::ParameterDescriptionNode::hasNestedContent_ ( ) const

inlineprotectedvirtual

Reimplemented in edm::ParameterDescription< std::vector< ParameterSet > >, edm::ParameterDescription< ParameterSetDescription >, edm::ParameterDescription< T >, edm::ParameterDescription< std::vector< std::string > >, edm::PluginDescription< T >, edm::ParameterWildcard< std::vector< ParameterSet > >, edm::ParameterWildcard< ParameterSetDescription >, edm::IfExistsDescription, edm::ParameterSwitchBase, edm::ANDGroupDescription, edm::XORGroupDescription, edm::ORGroupDescription, edm::AllowedLabelsDescriptionBase, and edm::ParameterWildcardWithSpecifics.

Definition at line 229 of file ParameterDescriptionNode.h.

Referenced by hasNestedContent().

{ return false; }

howManyXORSubNodesExist()

int edm::ParameterDescriptionNode::howManyXORSubNodesExist ( ParameterSet const &  pset ) const

inline

Definition at line 155 of file ParameterDescriptionNode.h.

References howManyXORSubNodesExist_(), and muonDTDigis_cfi::pset.

{ return howManyXORSubNodesExist_(pset); }

howManyXORSubNodesExist_()

virtual int edm::ParameterDescriptionNode::howManyXORSubNodesExist_ ( ParameterSet const &  pset ) const

protectedpure virtual

Implemented in edm::PluginDescription< T >, edm::ParameterSwitchBase, edm::ParameterDescriptionBase, edm::IfExistsDescription, edm::ANDGroupDescription, edm::XORGroupDescription, edm::ORGroupDescription, edm::AllowedLabelsDescriptionBase, edm::ParameterWildcardBase, and edm::EmptyGroupDescription.

Referenced by howManyXORSubNodesExist().

partiallyExists()

bool edm::ParameterDescriptionNode::partiallyExists ( ParameterSet const &  pset ) const

inline

Definition at line 142 of file ParameterDescriptionNode.h.

References partiallyExists_(), and muonDTDigis_cfi::pset.

Referenced by edm::ANDGroupDescription::validate_().

{ return partiallyExists_(pset); }

partiallyExists_()

virtual bool edm::ParameterDescriptionNode::partiallyExists_ ( ParameterSet const &  pset ) const

protectedpure virtual

Implemented in edm::PluginDescription< T >, edm::ParameterSwitchBase, edm::ParameterDescriptionBase, edm::IfExistsDescription, edm::ANDGroupDescription, edm::XORGroupDescription, edm::ORGroupDescription, edm::AllowedLabelsDescriptionBase, edm::ParameterWildcardBase, and edm::EmptyGroupDescription.

Referenced by partiallyExists().

print()

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

Definition at line 113 of file ParameterDescriptionNode.cc.

References hasNestedContent(), edm::DocFormatHelper::incrementCounter(), Types::optional, and print_().

Referenced by edm::AllowedLabelsDescriptionBase::printNestedContentBase_().

                                                                                                                 {
    if (hasNestedContent()) {
      dfh.incrementCounter();
    }
    print_(os, optional, writeToCfi, dfh);
  }

print_()

virtual void edm::ParameterDescriptionNode::print_ ( std::ostream &  , bool  , bool  , DocFormatHelper &    ) const

inlineprotectedvirtual

Reimplemented in edm::ParameterSwitch< T >, edm::ParameterDescriptionBase, edm::ParameterWildcardBase, edm::IfExistsDescription, edm::ANDGroupDescription, edm::XORGroupDescription, edm::ORGroupDescription, edm::AllowedLabelsDescriptionBase, and edm::EmptyGroupDescription.

Definition at line 227 of file ParameterDescriptionNode.h.

Referenced by print().

{}

printNestedContent()

void edm::ParameterDescriptionNode::printNestedContent	(	std::ostream &	os,
		bool	optional,
		DocFormatHelper &	dfh
	)		const

Definition at line 120 of file ParameterDescriptionNode.cc.

References hasNestedContent(), edm::DocFormatHelper::incrementCounter(), Types::optional, and printNestedContent_().

                                                                                                             {
    if (hasNestedContent()) {
      dfh.incrementCounter();
      printNestedContent_(os, optional, dfh);
    }
  }

printNestedContent_()

virtual void edm::ParameterDescriptionNode::printNestedContent_ ( std::ostream &  , bool  , DocFormatHelper &    ) const

inlineprotectedvirtual

Reimplemented in edm::ParameterDescription< std::vector< ParameterSet > >, edm::ParameterDescription< ParameterSetDescription >, edm::PluginDescription< T >, edm::ParameterWildcard< std::vector< ParameterSet > >, edm::ParameterSwitch< T >, edm::AllowedLabelsDescription< std::vector< ParameterSet > >, edm::ParameterWildcard< ParameterSetDescription >, edm::ParameterDescriptionBase, edm::AllowedLabelsDescription< ParameterSetDescription >, edm::IfExistsDescription, edm::ANDGroupDescription, edm::XORGroupDescription, edm::ORGroupDescription, edm::AllowedLabelsDescriptionBase, and edm::ParameterWildcardWithSpecifics.

Definition at line 231 of file ParameterDescriptionNode.h.

Referenced by printNestedContent().

{}

printSpaces()

void edm::ParameterDescriptionNode::printSpaces ( std::ostream &  os, int  n  )

static

Definition at line 127 of file ParameterDescriptionNode.cc.

References dqmiodumpmetadata::n.

Referenced by edm::ParameterWildcardWithSpecifics::printNestedContent_(), edm::ORGroupDescription::printNestedContent_(), edm::IfExistsDescription::printNestedContent_(), edm::XORGroupDescription::printNestedContent_(), edm::ANDGroupDescription::printNestedContent_(), edm::AllowedLabelsDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterDescriptionBase::printNestedContent_(), edm::ParameterWildcard< ParameterSetDescription >::printNestedContent_(), edm::PluginDescription< T >::printNestedContent_(), edm::ParameterDescription< ParameterSetDescription >::printNestedContent_(), edm::ParameterSwitchBase::printNestedContentBase(), edm::AllowedLabelsDescriptionBase::printNestedContentBase_(), and edm::ParameterDescriptionBase::writeCfi_().

                                                                  {
    char oldFill = os.fill(' ');
    os.width(n);
    os << "";
    os.fill(oldFill);
  }

setComment() [1/2]

void edm::ParameterDescriptionNode::setComment

(

std::string const &

value

)

Definition at line 109 of file ParameterDescriptionNode.cc.

References comment_, and relativeConstraints::value.

Referenced by ConfigToolBase.ConfigToolBase::apply(), hgcal::HGCalFrameGenerator::description(), reco::helper::JetIDHelper::fillDescription(), pat::helper::KinResolutionsLoader::fillDescription(), GEMSegmentBuilder::fillDescription(), ECFAdder::fillDescriptions(), PixelVertexCollectionTrimmer::fillDescriptions(), CTPPSOpticalFunctionsESSource::fillDescriptions(), PPSFilteredProtonProducer::fillDescriptions(), OnlineBeamSpotESProducer::fillDescriptions(), edmtest::ProducerWithPSetDesc::fillDescriptions(), CTPPSDiamondLocalTrackFitter::fillDescriptions(), CaloTowerFromL1TSeededCreatorForTauHLT::fillDescriptions(), CaloTowerFromL1TCreatorForTauHLT::fillDescriptions(), CaloTowerCreatorForTauHLT::fillDescriptions(), PFProducer::fillDescriptions(), TotemVFATRawToDigi::fillDescriptions(), CTPPSCompositeESSource::fillDescriptions(), pat::PATPhotonProducer::fillDescriptions(), pat::PATTauProducer::fillDescriptions(), L1TrackSelectionProducer::fillDescriptions(), pat::PATElectronProducer::fillDescriptions(), L1TGlobalPrescaler::fillDescriptions(), pat::PATMuonProducer::fillDescriptions(), TotemTimingLocalTrackFitter< T >::fillDescriptionsShared(), VertexTimeAlgorithmFromTracksPID::fillPSetDescription(), ticl::PatternRecognitionbyCLUE3D< TILES >::fillPSetDescription(), ticl::PatternRecognitionbyCA< TILES >::fillPSetDescription(), ticl::PatternRecognitionbyFastJet< TILES >::fillPSetDescription(), and PFEGammaFilters::fillPSetDescription().

{ comment_ = value; }

setComment() [2/2]

void edm::ParameterDescriptionNode::setComment

(

char const *

value

)

Definition at line 111 of file ParameterDescriptionNode.cc.

References comment_, and relativeConstraints::value.

Referenced by ConfigToolBase.ConfigToolBase::apply().

{ comment_ = value; }

validate()

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

inline

Definition at line 104 of file ParameterDescriptionNode.h.

References Types::optional, muonDTDigis_cfi::pset, and validate_().

Referenced by edm::AllowedLabelsDescriptionBase::validate_().

                                                                                               {
      validate_(pset, validatedLabels, optional);
    }

validate_()

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

protectedpure virtual

Implemented in edm::ParameterDescription< std::vector< ParameterSet > >, edm::ParameterDescription< ParameterSetDescription >, edm::PluginDescription< T >, edm::ParameterWildcard< std::vector< ParameterSet > >, edm::ParameterWildcard< ParameterSetDescription >, edm::ParameterSwitch< T >, edm::ParameterDescriptionBase, edm::ParameterWildcard< T >, edm::IfExistsDescription, edm::ANDGroupDescription, edm::XORGroupDescription, edm::ORGroupDescription, edm::AllowedLabelsDescriptionBase, edm::EmptyGroupDescription, and edm::ParameterWildcardWithSpecifics.

Referenced by validate().

writeCfi()

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

inline

Definition at line 118 of file ParameterDescriptionNode.h.

References printContent_cfi::indentation, Types::optional, and writeCfi_().

Referenced by edm::AllowedLabelsDescriptionBase::writeCfi_().

                                                                                                                    {
      writeCfi_(os, optional, startWithComma, indentation, wroteSomething);
    }

writeCfi_()

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

protectedpure virtual

Implemented in edm::PluginDescription< T >, edm::ParameterSwitch< T >, edm::ParameterDescriptionBase, edm::ParameterWildcardBase, edm::IfExistsDescription, edm::ANDGroupDescription, edm::XORGroupDescription, edm::ORGroupDescription, edm::AllowedLabelsDescriptionBase, and edm::EmptyGroupDescription.

Referenced by writeCfi().

Member Data Documentation

comment_

std::string edm::ParameterDescriptionNode::comment_

protected

Definition at line 239 of file ParameterDescriptionNode.h.

Referenced by comment(), and setComment().