edm::ParameterSetDescription Class Reference

#include <ParameterSetDescription.h>

Classes
class	SetDescriptionEntry

Public Types
typedef SetDescriptionEntries::const_iterator	const_iterator
typedef std::vector< SetDescriptionEntry >	SetDescriptionEntries

Public Member Functions
template<typename T , typename U >
ParameterDescriptionBase *	add (U const &iLabel)
template<typename T , typename U >
ParameterDescriptionBase *	add (U const &iLabel, T const &value)
ParameterDescriptionNode *	addNode (ParameterDescriptionNode const &node)
ParameterDescriptionNode *	addNode (std::unique_ptr< ParameterDescriptionNode > node)
template<typename T , typename U >
ParameterDescriptionBase *	addOptional (U const &iLabel)
template<typename T , typename U >
ParameterDescriptionBase *	addOptional (U const &iLabel, T const &value)
ParameterDescriptionNode *	addOptionalNode (ParameterDescriptionNode const &node, bool writeToCfi)
ParameterDescriptionNode *	addOptionalNode (std::unique_ptr< ParameterDescriptionNode > node, bool writeToCfi)
template<typename T , typename U >
ParameterDescriptionBase *	addOptionalUntracked (U const &iLabel)
template<typename T , typename U >
ParameterDescriptionBase *	addOptionalUntracked (U const &iLabel, T const &value)
template<typename T , typename U >
ParameterDescriptionBase *	addUntracked (U const &iLabel)
template<typename T , typename U >
ParameterDescriptionBase *	addUntracked (U const &iLabel, T const &value)
template<typename U >
ParameterDescriptionBase *	addVPSet (U const &iLabel, ParameterSetDescription const &validator)
template<typename U >
ParameterDescriptionBase *	addVPSet (U const &iLabel, ParameterSetDescription const &validator, std::vector< ParameterSet > const &defaults)
template<typename U >
ParameterDescriptionBase *	addVPSetOptional (U const &iLabel, ParameterSetDescription const &validator)
template<typename U >
ParameterDescriptionBase *	addVPSetOptional (U const &iLabel, ParameterSetDescription const &validator, std::vector< ParameterSet > const &defaults)
template<typename U >
ParameterDescriptionBase *	addVPSetOptionalUntracked (U const &iLabel, ParameterSetDescription const &validator)
template<typename U >
ParameterDescriptionBase *	addVPSetOptionalUntracked (U const &iLabel, ParameterSetDescription const &validator, std::vector< ParameterSet > const &defaults)
template<typename U >
ParameterDescriptionBase *	addVPSetUntracked (U const &iLabel, ParameterSetDescription const &validator)
template<typename U >
ParameterDescriptionBase *	addVPSetUntracked (U const &iLabel, ParameterSetDescription const &validator, std::vector< ParameterSet > const &defaults)
template<typename T , typename U >
ParameterWildcardBase *	addWildcard (U const &pattern)
template<typename T , typename U >
ParameterWildcardBase *	addWildcardUntracked (U const &pattern)
bool	anythingAllowed () const
const_iterator	begin () const
std::string const &	comment () const
const_iterator	end () const
ParameterDescriptionNode *	ifExists (ParameterDescriptionNode const &node1, ParameterDescriptionNode const &node2)
ParameterDescriptionNode *	ifExistsOptional (ParameterDescriptionNode const &node1, ParameterDescriptionNode const &node2, bool writeToCfi)
template<typename T >
ParameterDescriptionNode *	ifValue (ParameterDescription< T > const &switchParameter, std::unique_ptr< ParameterDescriptionCases< T >> cases)
template<typename T >
ParameterDescriptionNode *	ifValueOptional (ParameterDescription< T > const &switchParameter, std::unique_ptr< ParameterDescriptionCases< T >> cases, bool writeToCfi)
bool	isLabelUnused (std::string const &label) const
bool	isUnknown () const
template<typename T , typename U >
ParameterDescriptionNode *	labelsFrom (U const &iLabel)
template<typename T , typename U , typename V >
ParameterDescriptionNode *	labelsFrom (U const &iLabel, V const &desc)
template<typename T , typename U >
ParameterDescriptionNode *	labelsFromOptional (U const &iLabel, bool writeToCfi)
template<typename T , typename U , typename V >
ParameterDescriptionNode *	labelsFromOptional (U const &iLabel, bool writeToCfi, V const &desc)
template<typename T , typename U >
ParameterDescriptionNode *	labelsFromOptionalUntracked (U const &iLabel, bool writeToCfi)
template<typename T , typename U , typename V >
ParameterDescriptionNode *	labelsFromOptionalUntracked (U const &iLabel, bool writeToCfi, V const &desc)
template<typename T , typename U >
ParameterDescriptionNode *	labelsFromUntracked (U const &iLabel)
template<typename T , typename U , typename V >
ParameterDescriptionNode *	labelsFromUntracked (U const &iLabel, V const &desc)
	ParameterSetDescription ()
void	print (std::ostream &os, DocFormatHelper &dfh) const
void	reserve (SetDescriptionEntries::size_type n)
void	setAllowAnything ()
	allow any parameter label/value pairs More...
void	setComment (char const *value)
void	setComment (std::string const &value)
void	setUnknown ()
void	validate (ParameterSet &pset) const
void	writeCfi (std::ostream &os, bool startWithComma, int indentation) const
virtual	~ParameterSetDescription ()

Private Member Functions
template<typename T , typename U >
ParameterDescriptionBase *	add (U const &iLabel, bool isTracked, bool isOptional, bool writeToCfi)
template<typename T , typename U >
ParameterDescriptionBase *	add (U const &iLabel, T const &value, bool isTracked, bool isOptional, bool writeToCfi)
ParameterDescriptionNode *	addNode (std::unique_ptr< ParameterDescriptionNode > node, bool optional, bool writeToCfi)
template<typename U >
ParameterDescriptionBase *	addVPSet (U const &iLabel, ParameterSetDescription const &validator, bool isTracked, bool isOptional, bool writeToCfi)
template<typename U >
ParameterDescriptionBase *	addVPSet (U const &iLabel, ParameterSetDescription const &validator, std::vector< ParameterSet > const &defaults, bool isTracked, bool isOptional, bool writeToCfi)
template<typename T , typename U >
ParameterWildcardBase *	addWildcard (U const &pattern, bool isTracked)
ParameterDescriptionNode *	ifExists (ParameterDescriptionNode const &node1, ParameterDescriptionNode const &node2, bool optional, bool writeToCfi)
template<typename T >
ParameterDescriptionNode *	ifValue (ParameterDescription< T > const &switchParameter, std::unique_ptr< ParameterDescriptionCases< T >> cases, bool optional, bool writeToCfi)
template<typename T , typename U >
ParameterDescriptionNode *	labelsFrom (U const &iLabel, bool isTracked, bool optional, bool writeToCfi)
template<typename T , typename U , typename V >
ParameterDescriptionNode *	labelsFrom (U const &iLabel, bool isTracked, bool optional, bool writeToCfi, V const &desc)
void	throwIfLabelsAlreadyUsed (std::set< std::string > const &nodeLabels)
void	throwIfWildcardCollision (std::set< ParameterTypes > const &nodeParameterTypes, std::set< ParameterTypes > const &nodeWildcardTypes)

Static Private Member Functions
static void	printNode (SetDescriptionEntry const &entry, std::ostream &os, DocFormatHelper &dfh)
static void	throwIllegalParameters (std::vector< std::string > const &parameterNames, std::set< std::string > const &validatedNames)
static void	validateNode (SetDescriptionEntry const &entry, ParameterSet &pset, std::set< std::string > &validatedNames)
static void	writeNode (SetDescriptionEntry const &entry, std::ostream &os, bool &startWithComma, int indentation, bool &wroteSomething)

Private Attributes
bool	anythingAllowed_
std::string	comment_
SetDescriptionEntries	entries_
std::set< ParameterTypes >	typesUsedForParameters_
std::set< ParameterTypes >	typesUsedForWildcards_
bool	unknown_
std::set< std::string >	usedLabels_

Detailed Description

Definition at line 52 of file ParameterSetDescription.h.

Member Typedef Documentation

const_iterator

typedef SetDescriptionEntries::const_iterator edm::ParameterSetDescription::const_iterator

Definition at line 73 of file ParameterSetDescription.h.

SetDescriptionEntries

typedef std::vector<SetDescriptionEntry> edm::ParameterSetDescription::SetDescriptionEntries

Definition at line 72 of file ParameterSetDescription.h.

Constructor & Destructor Documentation

ParameterSetDescription()

ParameterSetDescription::ParameterSetDescription

(

)

Definition at line 29 of file ParameterSetDescription.cc.

: anythingAllowed_(false), unknown_(false) {}

~ParameterSetDescription()

ParameterSetDescription::~ParameterSetDescription ( )

virtual

Definition at line 31 of file ParameterSetDescription.cc.

{}

Member Function Documentation

add() [1/4]

template<typename T , typename U >

ParameterDescriptionBase* edm::ParameterSetDescription::add ( U const &  iLabel )

inline

Definition at line 118 of file ParameterSetDescription.h.

                                                   {
      return add<T, U>(iLabel, true, false, true);
    }

Referenced by counter.Counter::register(), SequenceTypes.Task::remove(), and SequenceTypes.Task::replace().

add() [2/4]

template<typename T , typename U >

ParameterDescriptionBase * ParameterSetDescription::add ( U const &  iLabel, bool  isTracked, bool  isOptional, bool  writeToCfi  )

private

Definition at line 399 of file ParameterSetDescription.h.

                                                                          {
    std::unique_ptr<ParameterDescriptionNode> node = std::make_unique<ParameterDescription<T>>(iLabel, isTracked);
    ParameterDescriptionNode* pnode = addNode(std::move(node), isOptional, writeToCfi);
    return static_cast<ParameterDescriptionBase*>(pnode);
  }

References addNode(), and eostools::move().

Referenced by counter.Counter::register(), SequenceTypes.Task::remove(), and SequenceTypes.Task::replace().

add() [3/4]

template<typename T , typename U >

ParameterDescriptionBase* edm::ParameterSetDescription::add ( U const &  iLabel, T const &  value  )

inline

Definition at line 95 of file ParameterSetDescription.h.

                                                                   {
      return add<T, U>(iLabel, value, true, false, true);
    }

Referenced by JetCorrectorImplMakerBase::addToDescription(), pat::helper::KinResolutionsLoader::fillDescription(), BeamFitter::fillDescription(), PVFitter::fillDescription(), pat::PATUserDataHelper< pat::MET >::fillDescription(), pat::PATUserDataMerger< pat::Jet, pat::helper::AddUserInt >::fillDescription(), PFTauSelector::fillDescriptions(), SeedGeneratorFromProtoTracksEDProducer::fillDescriptions(), L1TEnergySumFilterT< T >::fillDescriptions(), VertexAssociatorByTracksProducer::fillDescriptions(), HGCRecHitNavigator< D1, hgcee, D2, hgchef, D3, hgcheb >::fillDescriptions(), L1TJetFilterT< T >::fillDescriptions(), ECFAdder::fillDescriptions(), ParticleBasedIsoProducer::fillDescriptions(), PixelVertexCollectionTrimmer::fillDescriptions(), PFRecoTauDiscriminationByLeadingObjectPtCut::fillDescriptions(), CTPPSOpticalFunctionsESSource::fillDescriptions(), TrackerGeometricDetESModule::fillDescriptions(), EcalRecHitParametersGPUESProducer::fillDescriptions(), MTDGeometricTimingDetESModule::fillDescriptions(), HcalTimeSlewEP::fillDescriptions(), HBHEDarkeningEP::fillDescriptions(), PFTauDiscriminatorLogicalAndProducer::fillDescriptions(), SeedCreatorFromRegionHitsEDProducerT< T_SeedCreator >::fillDescriptions(), L1TPFTauFilter::fillDescriptions(), MVAJetPuIdProducer::fillDescriptions(), PPSFilteredProtonProducer::fillDescriptions(), GlobalTrackingRegionProducer::fillDescriptions(), L1THPSPFTauFilter::fillDescriptions(), TICLCandidateFromTrackstersProducer::fillDescriptions(), L1TTkEleFilter::fillDescriptions(), L1TTkEmFilter::fillDescriptions(), L1TTkMuonFilter::fillDescriptions(), PFRecoTauDiscriminationByHPSSelection::fillDescriptions(), cms::CSJetProducer::fillDescriptions(), PixelTripletHLTGenerator::fillDescriptions(), PFRecoTauDiscriminationByNProngs::fillDescriptions(), L2MuonIsolationProducer::fillDescriptions(), DTUnpackingModule::fillDescriptions(), EcalRecHitProducer::fillDescriptions(), EcalBarrelClusterFastTimer::fillDescriptions(), CaloTowerFromL1TSeededCreatorForTauHLT::fillDescriptions(), GlobalTrackQualityProducer::fillDescriptions(), L3MuonCombinedRelativeIsolationProducer::fillDescriptions(), AlcaPCCEventProducer::fillDescriptions(), citk::PFIsolationSumProducerForPUPPI::fillDescriptions(), TrackerDigiGeometryESModule::fillDescriptions(), TauHadronDecayFilter::fillDescriptions(), HcalSimpleReconstructor::fillDescriptions(), CTPPSDiamondLocalTrackFitter::fillDescriptions(), CaloTowerFromL1TCreatorForTauHLT::fillDescriptions(), PFRecoTauDiscriminationAgainstMuon::fillDescriptions(), ElectronSeedProducer::fillDescriptions(), BPHWriteSpecificDecay::fillDescriptions(), BeamSpotOnlineProducer::fillDescriptions(), HLTCaloJetIDProducer::fillDescriptions(), CaloTowerCreatorForTauHLT::fillDescriptions(), EcalMustacheSCParametersESProducer::fillDescriptions(), EcalSCDynamicDPhiParametersESProducer::fillDescriptions(), MkFitInputConverter::fillDescriptions(), GlobalTrackingRegionProducerFromBeamSpot::fillDescriptions(), pat::PATJetUpdater::fillDescriptions(), MTDDigiGeometryESModule::fillDescriptions(), DPFIsolation::fillDescriptions(), TotemTimingLocalTrackFitter::fillDescriptions(), RunInfoTestESProducer::fillDescriptions(), MeasurementTrackerESProducer::fillDescriptions(), HcalRecAlgoESProducer::fillDescriptions(), SiStripLorentzAngleDepESProducer::fillDescriptions(), CAHitTripletGenerator::fillDescriptions(), pat::PATMETProducer::fillDescriptions(), edm::service::PrescaleService::fillDescriptions(), PFProducer::fillDescriptions(), TopMonitor::fillDescriptions(), CAHitQuadrupletGenerator::fillDescriptions(), SiStripBackPlaneCorrectionDepESProducer::fillDescriptions(), TauDiscriminantCutMultiplexerT< TauType, TauTypeRef, ParentClass >::fillDescriptions(), L3MuonProducer::fillDescriptions(), citk::PFIsolationSumProducer::fillDescriptions(), CAHitNtupletGeneratorOnGPU::fillDescriptions(), Phase2ITMonitorCluster::fillDescriptions(), TemplatedInclusiveVertexFinder< InputContainer, VTX >::fillDescriptions(), Phase2OTMonitorCluster::fillDescriptions(), L2MuonProducer::fillDescriptions(), Phase1L1TJetCalibrator::fillDescriptions(), PFTauDecayModeCutMultiplexer::fillDescriptions(), TotemRPUVPatternFinder::fillDescriptions(), pat::PATJetProducer::fillDescriptions(), DDDetectorESProducer::fillDescriptions(), EgammaHLTNxNClusterProducer::fillDescriptions(), FastjetJetProducer::fillDescriptions(), Phase2ITMonitorRecHit::fillDescriptions(), RecoTauPiZeroProducer::fillDescriptions(), TemplatedVertexArbitrator< InputContainer, VTX >::fillDescriptions(), PPSAlignmentConfigESSource::fillDescriptions(), SiStripChannelGainFromDBMiscalibrator::fillDescriptions(), SiStripNoisesFromDBMiscalibrator::fillDescriptions(), ConversionTrackCandidateProducer::fillDescriptions(), GlobalTrackingRegionWithVerticesProducer::fillDescriptions(), pat::PATElectronProducer::fillDescriptions(), RecoTauProducer::fillDescriptions(), HITrackingRegionForPrimaryVtxProducer::fillDescriptions(), pat::PATTauProducer::fillDescriptions(), Phase2ITValidateCluster::fillDescriptions(), TrackingRegionsFromBeamSpotAndL2Tau::fillDescriptions(), CTPPSCompositeESSource::fillDescriptions(), pat::PATPhotonProducer::fillDescriptions(), BTagProbabilityToDiscriminator::fillDescriptions(), Phase2OTValidateCluster::fillDescriptions(), Phase2ITValidateRecHit::fillDescriptions(), HcalHardcodeCalibrations::fillDescriptions(), cms::PFMETProducer::fillDescriptions(), CorrectedECALPFClusterProducer::fillDescriptions(), PrimaryVertexProducer::fillDescriptions(), PFRecoTauChargedHadronProducer::fillDescriptions(), ApeTreeCreateDefault::fillDescriptions(), TauRegionalPixelSeedGenerator::fillDescriptions(), AreaSeededTrackingRegionsProducer::fillDescriptions(), ExternalLHEProducer::fillDescriptions(), PFRecoTauDiscriminationAgainstElectron2::fillDescriptions(), pat::JetCorrFactorsProducer::fillDescriptions(), SiPixelStatusProducer::fillDescriptions(), PrimaryVertexValidation::fillDescriptions(), GsfElectronProducer::fillDescriptions(), MuonIdProducer::fillDescriptions(), pat::PATMuonProducer::fillDescriptions(), EgammaHLTExtraProducer::fillDescriptions(), EgammaHLTPhase2ExtraProducer::fillDescriptions(), EgammaHLTFilteredObjProducer< OutCollType >::fillDescriptions(), TrackingRegionsFromSuperClustersProducer::fillDescriptions(), reco::tau::RecoTauQualityCuts::fillDescriptions(), HLTCaloObjInRegionsProducer< CaloObjType, CaloObjCollType >::fillDescriptions(), HLTRecHitInAllL1RegionsProducer< RecHitType >::fillDescriptions(), CandidateSeededTrackingRegionsProducer::fillDescriptions(), PointSeededTrackingRegionsProducer::fillDescriptions(), IsolatedTracksCone::fillDescriptions(), CandidatePointSeededTrackingRegionsProducer::fillDescriptions(), TopProjector< Top, Bottom, Matcher >::fillDescriptions(), PFRecoTauDiscriminationByIsolation::fillDescriptions(), pat::PATJetSelector::fillDescriptions(), PFRecoTauDiscriminationByIsolationContainer::fillDescriptions(), RecoTauCleanerImpl< Prod >::fillDescriptions(), GenWeightsTableProducer::fillDescriptions(), DeepTauId::fillDescriptions(), PuppiAlgo::fillDescriptionsPuppiAlgo(), TauDiscriminationProducerBase< TauType, TauDiscriminator >::fillProducerDescriptions(), PFMuonAlgo::fillPSetDescription(), PFEGammaFilters::fillPSetDescription(), L1TTkMuonFilter::MuonQualityCut::fillPSetDescription(), TritonClient::fillPSetDescription(), PFCandConnector::fillPSetDescription(), HGCalCLUEAlgoT< TILE >::fillPSetDescription(), HGCalImagingAlgo::fillPSetDescription(), PFTauPrimaryVertexProducerBase::getDescriptionsBase(), HLTDQMTagAndProbeEff< TagType, TagCollType, ProbeType, ProbeCollType >::makePSetDescription(), edm::eventsetup::DataProxyProvider::prevalidate(), counter.Counter::register(), SequenceTypes.Task::remove(), and SequenceTypes.Task::replace().

add() [4/4]

template<typename T , typename U >

ParameterDescriptionBase * ParameterSetDescription::add ( U const &  iLabel, T const &  value, bool  isTracked, bool  isOptional, bool  writeToCfi  )

private

Definition at line 390 of file ParameterSetDescription.h.

                                                                                         {
    std::unique_ptr<ParameterDescriptionNode> node =
        std::make_unique<ParameterDescription<T>>(iLabel, value, isTracked);
    ParameterDescriptionNode* pnode = addNode(std::move(node), isOptional, writeToCfi);
    return static_cast<ParameterDescriptionBase*>(pnode);
  }

References addNode(), eostools::move(), and relativeConstraints::value.

Referenced by counter.Counter::register(), SequenceTypes.Task::remove(), and SequenceTypes.Task::replace().

addNode() [1/3]

ParameterDescriptionNode * ParameterSetDescription::addNode

(

ParameterDescriptionNode const &

node

)

Definition at line 41 of file ParameterSetDescription.cc.

                                                                                                 {
    std::unique_ptr<ParameterDescriptionNode> clonedNode(node.clone());
    return addNode(std::move(clonedNode), false, true);
  }

References edm::ParameterDescriptionNode::clone(), and eostools::move().

Referenced by add(), addNode(), addOptionalNode(), addVPSet(), addWildcard(), EcalDQMonitorClient::fillDescriptions(), EcalDQMonitorTask::fillDescriptions(), TICLSeedingRegionProducer::fillDescriptions(), HGCalLayerClusterProducer::fillDescriptions(), pat::PATElectronProducer::fillDescriptions(), pat::PATTauProducer::fillDescriptions(), pat::PATPhotonProducer::fillDescriptions(), pat::PATMuonProducer::fillDescriptions(), EcalUncalibRecHitWorkerFixedAlphaBetaFit::getAlgoDescription(), EcalUncalibRecHitWorkerRatio::getAlgoDescription(), EcalUncalibRecHitWorkerGlobal::getAlgoDescription(), EcalUncalibRecHitWorkerMultiFit::getAlgoDescription(), ifExists(), ifValue(), and labelsFrom().

addNode() [2/3]

ParameterDescriptionNode * ParameterSetDescription::addNode

(

std::unique_ptr< ParameterDescriptionNode >

node

)

Definition at line 46 of file ParameterSetDescription.cc.

                                                                                                         {
    return addNode(std::move(node), false, true);
  }

References addNode(), and eostools::move().

addNode() [3/3]

ParameterDescriptionNode * ParameterSetDescription::addNode ( std::unique_ptr< ParameterDescriptionNode >  node, bool  optional, bool  writeToCfi  )

private

Definition at line 61 of file ParameterSetDescription.cc.

                                                                              {
    std::set<std::string> nodeLabels;
    std::set<ParameterTypes> nodeParameterTypes;
    std::set<ParameterTypes> nodeWildcardTypes;
    node->checkAndGetLabelsAndTypes(nodeLabels, nodeParameterTypes, nodeWildcardTypes);
    throwIfLabelsAlreadyUsed(nodeLabels);
    throwIfWildcardCollision(nodeParameterTypes, nodeWildcardTypes);
 
    SetDescriptionEntry entry;
    entry.setOptional(optional);
    entry.setWriteToCfi(writeToCfi);
    entries_.push_back(entry);
    return entries_.back().setNode(std::move(node));
  }

References edm::ParameterDescriptionNode::checkAndGetLabelsAndTypes(), entries_, mps_splice::entry, eostools::move(), Types::optional, throwIfLabelsAlreadyUsed(), and throwIfWildcardCollision().

addOptional() [1/2]

template<typename T , typename U >

ParameterDescriptionBase* edm::ParameterSetDescription::addOptional ( U const &  iLabel )

inline

Definition at line 128 of file ParameterSetDescription.h.

                                                           {
      return add<T, U>(iLabel, true, true, true);
    }

addOptional() [2/2]

template<typename T , typename U >

ParameterDescriptionBase* edm::ParameterSetDescription::addOptional ( U const &  iLabel, T const &  value  )

inline

Definition at line 105 of file ParameterSetDescription.h.

                                                                           {
      return add<T, U>(iLabel, value, true, true, true);
    }

Referenced by pat::helper::KinResolutionsLoader::fillDescription(), edm::EventSelector::fillDescription(), pat::PATUserDataMerger< pat::Jet, pat::helper::AddUserInt >::fillDescription(), citk::PFIsolationSumProducerForPUPPI::fillDescriptions(), SiPixelRawToDigi::fillDescriptions(), PFRecoTauDiscriminationAgainstMuon::fillDescriptions(), pat::PATJetUpdater::fillDescriptions(), pat::PATMETProducer::fillDescriptions(), citk::PFIsolationSumProducer::fillDescriptions(), SiPixelRawToClusterCUDA::fillDescriptions(), pat::PATJetProducer::fillDescriptions(), RecoTauPiZeroProducer::fillDescriptions(), RecoTauProducer::fillDescriptions(), pat::PATElectronProducer::fillDescriptions(), pat::PATTauProducer::fillDescriptions(), pat::PATPhotonProducer::fillDescriptions(), PFRecoTauChargedHadronProducer::fillDescriptions(), PFRecoTauDiscriminationAgainstElectron2::fillDescriptions(), pat::PATMuonProducer::fillDescriptions(), reco::tau::RecoTauQualityCuts::fillDescriptions(), PFRecoTauDiscriminationByIsolation::fillDescriptions(), PFRecoTauDiscriminationByIsolationContainer::fillDescriptions(), RecoTauCleanerImpl< Prod >::fillDescriptions(), DeepTauId::fillDescriptions(), and TauDiscriminationProducerBase< TauType, TauDiscriminator >::fillProducerDescriptions().

addOptionalNode() [1/2]

ParameterDescriptionNode * ParameterSetDescription::addOptionalNode	(	ParameterDescriptionNode const &	node,
		bool	writeToCfi
	)

Definition at line 50 of file ParameterSetDescription.cc.

                                                                                      {
    std::unique_ptr<ParameterDescriptionNode> clonedNode(node.clone());
    return addNode(std::move(clonedNode), true, writeToCfi);
  }

References addNode(), edm::ParameterDescriptionNode::clone(), and eostools::move().

Referenced by ecaldqm::binning::fillAxisDescriptions(), and EcalUncalibRecHitWorkerMultiFit::getAlgoDescription().

addOptionalNode() [2/2]

ParameterDescriptionNode * ParameterSetDescription::addOptionalNode	(	std::unique_ptr< ParameterDescriptionNode >	node,
		bool	writeToCfi
	)

Definition at line 56 of file ParameterSetDescription.cc.

                                                                                      {
    return addNode(std::move(node), true, writeToCfi);
  }

References addNode(), and eostools::move().

addOptionalUntracked() [1/2]

template<typename T , typename U >

ParameterDescriptionBase* edm::ParameterSetDescription::addOptionalUntracked ( U const &  iLabel )

inline

Definition at line 133 of file ParameterSetDescription.h.

                                                                    {
      return add<T, U>(iLabel, false, true, true);
    }

addOptionalUntracked() [2/2]

template<typename T , typename U >

ParameterDescriptionBase* edm::ParameterSetDescription::addOptionalUntracked ( U const &  iLabel, T const &  value  )

inline

Definition at line 110 of file ParameterSetDescription.h.

                                                                                    {
      return add<T, U>(iLabel, value, false, true, true);
    }

Referenced by edm::edmodule_mightGet_config(), ecaldqm::binning::fillAxisDescriptions(), and ecaldqm::fillMESetDescriptions().

addUntracked() [1/2]

template<typename T , typename U >

ParameterDescriptionBase* edm::ParameterSetDescription::addUntracked ( U const &  iLabel )

inline

Definition at line 123 of file ParameterSetDescription.h.

                                                            {
      return add<T, U>(iLabel, false, false, true);
    }

addUntracked() [2/2]

template<typename T , typename U >

ParameterDescriptionBase* edm::ParameterSetDescription::addUntracked ( U const &  iLabel, T const &  value  )

inline

Definition at line 100 of file ParameterSetDescription.h.

                                                                            {
      return add<T, U>(iLabel, value, false, false, true);
    }

Referenced by ecaldqm::binning::fillAxisDescriptions(), BeamFitter::fillDescription(), PVFitter::fillDescription(), edm::PoolOutputModule::fillDescription(), edm::TestSource::fillDescriptions(), CUDAService::fillDescriptions(), ecaldqm::DQWorkerClient::fillDescriptions(), ecaldqm::EcalDQMonitor::fillDescriptions(), DTUnpackingModule::fillDescriptions(), SiStripDetVOffPrinter::fillDescriptions(), CaloTowerFromL1TSeededCreatorForTauHLT::fillDescriptions(), OnlineBeamMonitor::fillDescriptions(), AlcaPCCEventProducer::fillDescriptions(), AlcaBeamMonitor::fillDescriptions(), CaloTowerFromL1TCreatorForTauHLT::fillDescriptions(), BeamSpotOnlineProducer::fillDescriptions(), CaloTowerCreatorForTauHLT::fillDescriptions(), BeamSpotRcdPrinter::fillDescriptions(), SiStripLorentzAngleDepESProducer::fillDescriptions(), SiStripBackPlaneCorrectionDepESProducer::fillDescriptions(), L3MuonProducer::fillDescriptions(), L2MuonProducer::fillDescriptions(), edm::service::CheckTransitions::fillDescriptions(), ecaldqm::DQWorker::fillDescriptions(), L2MuonSeedGeneratorFromL1T::fillDescriptions(), L2MuonSeedGeneratorFromL1TkMu::fillDescriptions(), MCMisalignmentScaler::fillDescriptions(), SiPixelStatusProducer::fillDescriptions(), TritonService::fillDescriptions(), TopProjector< Top, Bottom, Matcher >::fillDescriptions(), FastTimerService::fillDescriptions(), ecaldqm::fillMESetDescriptions(), edm::fillOptionsDescription(), TritonClient::fillPSetDescription(), HGCalCLUEAlgoT< TILE >::fillPSetDescription(), and HGCalImagingAlgo::fillPSetDescription().

addVPSet() [1/4]

template<typename U >

ParameterDescriptionBase* edm::ParameterSetDescription::addVPSet ( U const &  iLabel, ParameterSetDescription const &  validator  )

inline

Definition at line 177 of file ParameterSetDescription.h.

                                                                                                  {
      return addVPSet<U>(iLabel, validator, true, false, true);
    }

addVPSet() [2/4]

template<typename U >

ParameterDescriptionBase * ParameterSetDescription::addVPSet ( U const &  iLabel, ParameterSetDescription const &  validator, bool  isTracked, bool  isOptional, bool  writeToCfi  )

private

Definition at line 422 of file ParameterSetDescription.h.

                                                                                                                   {
    std::unique_ptr<ParameterDescriptionNode> node =
        std::make_unique<ParameterDescription<std::vector<ParameterSet>>>(iLabel, validator, isTracked);
    ParameterDescriptionNode* pnode = addNode(std::move(node), isOptional, writeToCfi);
    return static_cast<ParameterDescriptionBase*>(pnode);
  }

References addNode(), and eostools::move().

addVPSet() [3/4]

template<typename U >

ParameterDescriptionBase* edm::ParameterSetDescription::addVPSet ( U const &  iLabel, ParameterSetDescription const &  validator, std::vector< ParameterSet > const &  defaults  )

inline

Definition at line 149 of file ParameterSetDescription.h.

                                                                                {
      return addVPSet<U>(iLabel, validator, defaults, true, false, true);
    }

References l1GtPatternGenerator_cfi::defaults.

Referenced by CTPPSOpticalFunctionsESSource::fillDescriptions(), citk::PFIsolationSumProducerForPUPPI::fillDescriptions(), and citk::PFIsolationSumProducer::fillDescriptions().

addVPSet() [4/4]

template<typename U >

ParameterDescriptionBase * ParameterSetDescription::addVPSet ( U const &  iLabel, ParameterSetDescription const &  validator, std::vector< ParameterSet > const &  defaults, bool  isTracked, bool  isOptional, bool  writeToCfi  )

private

Definition at line 409 of file ParameterSetDescription.h.

                                                                               {
    std::unique_ptr<ParameterDescriptionNode> node =
        std::make_unique<ParameterDescription<std::vector<ParameterSet>>>(iLabel, validator, isTracked, defaults);
    ParameterDescriptionNode* pnode = addNode(std::move(node), isOptional, writeToCfi);
    return static_cast<ParameterDescriptionBase*>(pnode);
  }

References addNode(), l1GtPatternGenerator_cfi::defaults, and eostools::move().

addVPSetOptional() [1/2]

template<typename U >

ParameterDescriptionBase* edm::ParameterSetDescription::addVPSetOptional ( U const &  iLabel, ParameterSetDescription const &  validator  )

inline

Definition at line 187 of file ParameterSetDescription.h.

                                                                                                          {
      return addVPSet<U>(iLabel, validator, true, true, true);
    }

addVPSetOptional() [2/2]

template<typename U >

ParameterDescriptionBase* edm::ParameterSetDescription::addVPSetOptional ( U const &  iLabel, ParameterSetDescription const &  validator, std::vector< ParameterSet > const &  defaults  )

inline

Definition at line 163 of file ParameterSetDescription.h.

                                                                                        {
      return addVPSet<U>(iLabel, validator, defaults, true, true, true);
    }

References l1GtPatternGenerator_cfi::defaults.

Referenced by RecoTauProducer::fillDescriptions().

addVPSetOptionalUntracked() [1/2]

template<typename U >

ParameterDescriptionBase* edm::ParameterSetDescription::addVPSetOptionalUntracked ( U const &  iLabel, ParameterSetDescription const &  validator  )

inline

Definition at line 192 of file ParameterSetDescription.h.

                                                                                                                   {
      return addVPSet<U>(iLabel, validator, false, true, true);
    }

addVPSetOptionalUntracked() [2/2]

template<typename U >

ParameterDescriptionBase* edm::ParameterSetDescription::addVPSetOptionalUntracked ( U const &  iLabel, ParameterSetDescription const &  validator, std::vector< ParameterSet > const &  defaults  )

inline

Definition at line 170 of file ParameterSetDescription.h.

                                                                                                 {
      return addVPSet<U>(iLabel, validator, defaults, false, true, true);
    }

References l1GtPatternGenerator_cfi::defaults.

addVPSetUntracked() [1/2]

template<typename U >

ParameterDescriptionBase* edm::ParameterSetDescription::addVPSetUntracked ( U const &  iLabel, ParameterSetDescription const &  validator  )

inline

Definition at line 182 of file ParameterSetDescription.h.

                                                                                                           {
      return addVPSet<U>(iLabel, validator, false, false, true);
    }

addVPSetUntracked() [2/2]

template<typename U >

ParameterDescriptionBase* edm::ParameterSetDescription::addVPSetUntracked ( U const &  iLabel, ParameterSetDescription const &  validator, std::vector< ParameterSet > const &  defaults  )

inline

Definition at line 156 of file ParameterSetDescription.h.

                                                                                         {
      return addVPSet<U>(iLabel, validator, defaults, false, false, true);
    }

References l1GtPatternGenerator_cfi::defaults.

addWildcard() [1/2]

template<typename T , typename U >

ParameterWildcardBase* edm::ParameterSetDescription::addWildcard ( U const &  pattern )

inline

Definition at line 199 of file ParameterSetDescription.h.

                                                         {
      return addWildcard<T, U>(pattern, true);
    }

References topSingleLeptonDQM_PU_cfi::pattern.

Referenced by pat::PATObjectUserDataEmbedder< T >::fillDescriptions().

addWildcard() [2/2]

template<typename T , typename U >

ParameterWildcardBase * ParameterSetDescription::addWildcard ( U const &  pattern, bool  isTracked  )

private

Definition at line 431 of file ParameterSetDescription.h.

                                                                                              {
    std::unique_ptr<ParameterDescriptionNode> node =
        std::make_unique<ParameterWildcard<T>>(pattern, RequireZeroOrMore, isTracked);
    ParameterDescriptionNode* pnode = addNode(std::move(node), true, false);
    return static_cast<ParameterWildcardBase*>(pnode);
  }

References addNode(), eostools::move(), topSingleLeptonDQM_PU_cfi::pattern, and edm::RequireZeroOrMore.

addWildcardUntracked()

template<typename T , typename U >

ParameterWildcardBase* edm::ParameterSetDescription::addWildcardUntracked ( U const &  pattern )

inline

Definition at line 204 of file ParameterSetDescription.h.

                                                                  {
      return addWildcard<T, U>(pattern, false);
    }

References topSingleLeptonDQM_PU_cfi::pattern.

Referenced by ecaldqm::DQWorkerClient::fillDescriptions(), edm::fillMaxEventsDescription(), ecaldqm::fillMESetDescriptions(), and edm::fillOptionsDescription().

anythingAllowed()

bool edm::ParameterSetDescription::anythingAllowed ( ) const

inline

Definition at line 292 of file ParameterSetDescription.h.

{ return anythingAllowed_; }

References anythingAllowed_.

Referenced by print(), and validate().

begin()

const_iterator edm::ParameterSetDescription::begin ( void  ) const

inline

Definition at line 295 of file ParameterSetDescription.h.

{ return entries_.begin(); }

References entries_.

comment()

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

inline

Definition at line 78 of file ParameterSetDescription.h.

{ return comment_; }

References comment_.

end()

const_iterator edm::ParameterSetDescription::end ( void  ) const

inline

Definition at line 297 of file ParameterSetDescription.h.

{ return entries_.end(); }

References entries_.

Referenced by Types.LuminosityBlockRange::cppID(), and Types.EventRange::cppID().

ifExists() [1/2]

ParameterDescriptionNode* edm::ParameterSetDescription::ifExists ( ParameterDescriptionNode const &  node1, ParameterDescriptionNode const &  node2  )

inline

Definition at line 233 of file ParameterSetDescription.h.

                                                                                                                     {
      return ifExists(node1, node2, false, true);
    }

Referenced by ifExistsOptional().

ifExists() [2/2]

ParameterDescriptionNode * ParameterSetDescription::ifExists ( ParameterDescriptionNode const &  node1, ParameterDescriptionNode const &  node2, bool  optional, bool  writeToCfi  )

private

Definition at line 319 of file ParameterSetDescription.cc.

                                                                               {
    std::unique_ptr<ParameterDescriptionNode> pdIfExists = std::make_unique<IfExistsDescription>(node1, node2);
    return addNode(std::move(pdIfExists), optional, writeToCfi);
  }

References addNode(), eostools::move(), and Types::optional.

ifExistsOptional()

ParameterDescriptionNode* edm::ParameterSetDescription::ifExistsOptional ( ParameterDescriptionNode const &  node1, ParameterDescriptionNode const &  node2, bool  writeToCfi  )

inline

Definition at line 237 of file ParameterSetDescription.h.

                                                                {
      return ifExists(node1, node2, true, writeToCfi);
    }

References ifExists().

ifValue() [1/2]

template<typename T >

ParameterDescriptionNode* edm::ParameterSetDescription::ifValue ( ParameterDescription< T > const &  switchParameter, std::unique_ptr< ParameterDescriptionCases< T >>  cases  )

inline

Definition at line 220 of file ParameterSetDescription.h.

                                                                                         {
      return ifValue<T>(switchParameter, std::move(cases), false, true);
    }

References eostools::move().

Referenced by reco::helper::JetIDHelper::fillDescription(), pat::PATElectronProducer::fillDescriptions(), pat::PATPhotonProducer::fillDescriptions(), pat::PATMuonProducer::fillDescriptions(), and EgammaHLTPixelMatchVarProducer::fillDescriptions().

ifValue() [2/2]

template<typename T >

ParameterDescriptionNode * ParameterSetDescription::ifValue ( ParameterDescription< T > const &  switchParameter, std::unique_ptr< ParameterDescriptionCases< T >>  cases, bool  optional, bool  writeToCfi  )

private

Definition at line 439 of file ParameterSetDescription.h.

                                                                              {
    std::unique_ptr<ParameterDescriptionNode> pdswitch =
        std::make_unique<ParameterSwitch<T>>(switchParameter, std::move(cases));
    return addNode(std::move(pdswitch), optional, writeToCfi);
  }

References addNode(), eostools::move(), and Types::optional.

ifValueOptional()

template<typename T >

ParameterDescriptionNode* edm::ParameterSetDescription::ifValueOptional ( ParameterDescription< T > const &  switchParameter, std::unique_ptr< ParameterDescriptionCases< T >>  cases, bool  writeToCfi  )

inline

Definition at line 226 of file ParameterSetDescription.h.

                                                               {
      return ifValue<T>(switchParameter, std::move(cases), true, writeToCfi);
    }

References eostools::move().

isLabelUnused()

bool ParameterSetDescription::isLabelUnused

(

std::string const &

label

)

const

Definition at line 191 of file ParameterSetDescription.cc.

                                                                          {
    return usedLabels_.find(label) == usedLabels_.end();
  }

References label, and usedLabels_.

Referenced by edm::edmodule_mightGet_config(), and edm::eventsetup::DataProxyProvider::prevalidate().

isUnknown()

bool edm::ParameterSetDescription::isUnknown ( ) const

inline

Definition at line 293 of file ParameterSetDescription.h.

{ return unknown_; }

References unknown_.

Referenced by edm::ConfigurationDescriptions::print(), and print().

labelsFrom() [1/4]

template<typename T , typename U >

ParameterDescriptionNode* edm::ParameterSetDescription::labelsFrom ( U const &  iLabel )

inline

Definition at line 245 of file ParameterSetDescription.h.

                                                          {
      return labelsFrom<T, U>(iLabel, true, false, true);
    }

labelsFrom() [2/4]

template<typename T , typename U >

ParameterDescriptionNode * ParameterSetDescription::labelsFrom ( U const &  iLabel, bool  isTracked, bool  optional, bool  writeToCfi  )

private

Definition at line 449 of file ParameterSetDescription.h.

                                                                                 {
    std::unique_ptr<ParameterDescriptionNode> pd = std::make_unique<AllowedLabelsDescription<T>>(iLabel, isTracked);
    return addNode(std::move(pd), optional, writeToCfi);
  }

References addNode(), eostools::move(), and Types::optional.

labelsFrom() [3/4]

template<typename T , typename U , typename V >

ParameterDescriptionNode * ParameterSetDescription::labelsFrom ( U const &  iLabel, bool  isTracked, bool  optional, bool  writeToCfi, V const &  desc  )

private

Definition at line 458 of file ParameterSetDescription.h.

                                                                                      {
    std::unique_ptr<ParameterDescriptionNode> pd =
        std::make_unique<AllowedLabelsDescription<T>>(iLabel, desc, isTracked);
    return addNode(std::move(pd), optional, writeToCfi);
  }

References addNode(), submitPVResolutionJobs::desc, eostools::move(), and Types::optional.

labelsFrom() [4/4]

template<typename T , typename U , typename V >

ParameterDescriptionNode* edm::ParameterSetDescription::labelsFrom ( U const &  iLabel, V const &  desc  )

inline

Definition at line 273 of file ParameterSetDescription.h.

                                                                         {
      return labelsFrom<T, U, V>(iLabel, true, false, true, desc);
    }

References submitPVResolutionJobs::desc.

labelsFromOptional() [1/2]

template<typename T , typename U >

ParameterDescriptionNode* edm::ParameterSetDescription::labelsFromOptional ( U const &  iLabel, bool  writeToCfi  )

inline

Definition at line 255 of file ParameterSetDescription.h.

                                                                                   {
      return labelsFrom<T, U>(iLabel, true, true, writeToCfi);
    }

labelsFromOptional() [2/2]

template<typename T , typename U , typename V >

ParameterDescriptionNode* edm::ParameterSetDescription::labelsFromOptional ( U const &  iLabel, bool  writeToCfi, V const &  desc  )

inline

Definition at line 283 of file ParameterSetDescription.h.

                                                                                                  {
      return labelsFrom<T, U, V>(iLabel, true, true, writeToCfi, desc);
    }

References submitPVResolutionJobs::desc.

labelsFromOptionalUntracked() [1/2]

template<typename T , typename U >

ParameterDescriptionNode* edm::ParameterSetDescription::labelsFromOptionalUntracked ( U const &  iLabel, bool  writeToCfi  )

inline

Definition at line 260 of file ParameterSetDescription.h.

                                                                                            {
      return labelsFrom<T, U>(iLabel, false, true, writeToCfi);
    }

labelsFromOptionalUntracked() [2/2]

template<typename T , typename U , typename V >

ParameterDescriptionNode* edm::ParameterSetDescription::labelsFromOptionalUntracked ( U const &  iLabel, bool  writeToCfi, V const &  desc  )

inline

Definition at line 288 of file ParameterSetDescription.h.

                                                                                                           {
      return labelsFrom<T, U, V>(iLabel, false, true, writeToCfi, desc);
    }

References submitPVResolutionJobs::desc.

labelsFromUntracked() [1/2]

template<typename T , typename U >

ParameterDescriptionNode* edm::ParameterSetDescription::labelsFromUntracked ( U const &  iLabel )

inline

Definition at line 250 of file ParameterSetDescription.h.

                                                                   {
      return labelsFrom<T, U>(iLabel, false, false, true);
    }

labelsFromUntracked() [2/2]

template<typename T , typename U , typename V >

ParameterDescriptionNode* edm::ParameterSetDescription::labelsFromUntracked ( U const &  iLabel, V const &  desc  )

inline

Definition at line 278 of file ParameterSetDescription.h.

                                                                                  {
      return labelsFrom<T, U, V>(iLabel, false, false, true, desc);
    }

References submitPVResolutionJobs::desc.

print()

void ParameterSetDescription::print	(	std::ostream &	os,
		DocFormatHelper &	dfh
	)		const

Definition at line 146 of file ParameterSetDescription.cc.

                                                                                {
    using std::placeholders::_1;
    if (isUnknown()) {
      dfh.indent(os);
      os << "Description is unknown.  The configured PSet will not be validated\n";
      dfh.indent(os);
      os << "because the plugin has not defined this parameter set description.\n";
      if (!dfh.brief())
        os << "\n";
    }
 
    if (anythingAllowed()) {
      dfh.indent(os);
      os << "Description allows anything. If the configured PSet contains illegal parameters,\n";
      dfh.indent(os);
      os << "then validation will ignore them instead of throwing an exception.\n";
      if (!dfh.brief())
        os << "\n";
    }
 
    if (entries_.empty()) {
      dfh.indent(os);
      os << "Description is empty\n";
      if (!dfh.brief())
        os << "\n";
      return;
    }
 
    // Zeroth pass is only to calculate column widths in advance of any printing
    dfh.setPass(0);
    dfh.setCounter(0);
    for_all(entries_, std::bind(&ParameterSetDescription::printNode, _1, std::ref(os), std::ref(dfh)));
 
    // First pass prints top level parameters and references to structure
    dfh.setPass(1);
    dfh.setCounter(0);
    for_all(entries_, std::bind(&ParameterSetDescription::printNode, _1, std::ref(os), std::ref(dfh)));
 
    // Second pass prints substructure that goes into different sections of the
    // output document
    dfh.setPass(2);
    dfh.setCounter(0);
    for_all(entries_, std::bind(&ParameterSetDescription::printNode, _1, std::ref(os), std::ref(dfh)));
  }

References anythingAllowed(), edm::DocFormatHelper::brief(), entries_, edm::for_all(), edm::DocFormatHelper::indent(), isUnknown(), printNode(), edm::DocFormatHelper::setCounter(), and edm::DocFormatHelper::setPass().

Referenced by edm::ParameterWildcardWithSpecifics::printNestedContent_(), and edm::ParameterDescription< std::vector< ParameterSet > >::printNestedContent_().

printNode()

void ParameterSetDescription::printNode ( SetDescriptionEntry const &  entry, std::ostream &  os, DocFormatHelper &  dfh  )

staticprivate

Definition at line 227 of file ParameterSetDescription.cc.

                                                                                                                {
    if (dfh.pass() < 2) {
      entry.node()->print(os, entry.optional(), entry.writeToCfi(), dfh);
    } else {
      entry.node()->printNestedContent(os, entry.optional(), dfh);
    }
  }

References mps_splice::entry, and edm::DocFormatHelper::pass().

Referenced by print().

reserve()

void edm::ParameterSetDescription::reserve ( SetDescriptionEntries::size_type  n )

inline

Definition at line 301 of file ParameterSetDescription.h.

{ entries_.reserve(n); }

References entries_, and dqmiodumpmetadata::n.

Referenced by EcalRecHitProducer::fillDescriptions().

setAllowAnything()

void ParameterSetDescription::setAllowAnything

(

)

allow any parameter label/value pairs

Definition at line 37 of file ParameterSetDescription.cc.

{ anythingAllowed_ = true; }

References anythingAllowed_.

Referenced by pat::helper::KinResolutionsLoader::fillDescription(), GEMEfficiencyAnalyzer::fillDescriptions(), SeedCreatorFromRegionHitsEDProducerT< T_SeedCreator >::fillDescriptions(), PixelTripletHLTGenerator::fillDescriptions(), HIMuonTrackingRegionProducer::fillDescriptions(), GlobalTrackQualityProducer::fillDescriptions(), pat::PATMETProducer::fillDescriptions(), pat::PATJetProducer::fillDescriptions(), NanoAODOutputModule::fillDescriptions(), pat::PATElectronProducer::fillDescriptions(), pat::PATTauProducer::fillDescriptions(), pat::PATPhotonProducer::fillDescriptions(), MuonIdProducer::fillDescriptions(), and pat::PATMuonProducer::fillDescriptions().

setComment() [1/2]

void ParameterSetDescription::setComment

(

char const *

value

)

Definition at line 35 of file ParameterSetDescription.cc.

{ comment_ = value; }

References comment_, and relativeConstraints::value.

Referenced by ConfigToolBase.ConfigToolBase::apply().

setComment() [2/2]

void ParameterSetDescription::setComment

(

std::string const &

value

)

Definition at line 33 of file ParameterSetDescription.cc.

{ comment_ = value; }

References comment_, and relativeConstraints::value.

Referenced by ConfigToolBase.ConfigToolBase::apply(), ECFAdder::fillDescriptions(), citk::PFIsolationSumProducerForPUPPI::fillDescriptions(), pat::PATJetUpdater::fillDescriptions(), pat::PATMETProducer::fillDescriptions(), citk::PFIsolationSumProducer::fillDescriptions(), pat::PATJetProducer::fillDescriptions(), SiStripChannelGainFromDBMiscalibrator::fillDescriptions(), SiStripNoisesFromDBMiscalibrator::fillDescriptions(), pat::PATElectronProducer::fillDescriptions(), pat::PATTauProducer::fillDescriptions(), pat::PATPhotonProducer::fillDescriptions(), MCMisalignmentScaler::fillDescriptions(), pat::PATMuonProducer::fillDescriptions(), and pat::PATJetSelector::fillDescriptions().

setUnknown()

void ParameterSetDescription::setUnknown

(

)

Definition at line 39 of file ParameterSetDescription.cc.

{ unknown_ = true; }

References unknown_.

Referenced by LowPtGsfElectronFinalizer::fillDescriptions(), ConversionTrackCandidateProducer::fillDescriptions(), and PFSimParticleProducer::fillDescriptions().

throwIfLabelsAlreadyUsed()

void ParameterSetDescription::throwIfLabelsAlreadyUsed ( std::set< std::string > const &  nodeLabels )

private

Definition at line 235 of file ParameterSetDescription.cc.

                                                                                            {
    std::set<std::string> duplicateLabels;
    std::insert_iterator<std::set<std::string> > insertIter(duplicateLabels, duplicateLabels.begin());
    std::set_intersection(nodeLabels.begin(), nodeLabels.end(), usedLabels_.begin(), usedLabels_.end(), insertIter);
    if (duplicateLabels.empty()) {
      usedLabels_.insert(nodeLabels.begin(), nodeLabels.end());
    } else {
      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 different nodes of a ParameterSetDescription\n"
                                               << "must be unique.  The following duplicate labels were detected:\n"
                                               << ss.str() << "\n";
    }
  }

References Exception, edm::errors::LogicError, contentValuesCheck::ss, and usedLabels_.

Referenced by addNode().

throwIfWildcardCollision()

void ParameterSetDescription::throwIfWildcardCollision ( std::set< ParameterTypes > const &  nodeParameterTypes, std::set< ParameterTypes > const &  nodeWildcardTypes  )

private

Definition at line 254 of file ParameterSetDescription.cc.

                                                                                                          {
    // 1. Check that the new wildcard types do not collide with the existing
    // parameter types.
    // 2. Check that the new parameter types do not collide with the existing
    // wildcard types.
    // 3. Then insert them.
    // The order of those steps is important because a wildcard with a default
    // value could insert a type in both sets and this is OK.
 
    // We assume the node already checked for collisions between the new parameter
    // types and the new wildcard types before passing the sets to this function.
 
    if (!nodeWildcardTypes.empty()) {
      std::set<ParameterTypes> duplicateTypes1;
      std::insert_iterator<std::set<ParameterTypes> > insertIter1(duplicateTypes1, duplicateTypes1.begin());
      std::set_intersection(typesUsedForParameters_.begin(),
                            typesUsedForParameters_.end(),
                            nodeWildcardTypes.begin(),
                            nodeWildcardTypes.end(),
                            insertIter1);
 
      if (!duplicateTypes1.empty()) {
        std::stringstream ss;
        for (std::set<ParameterTypes>::const_iterator iter = duplicateTypes1.begin(), iEnd = duplicateTypes1.end();
             iter != iEnd;
             ++iter) {
          ss << " \"" << parameterTypeEnumToString(*iter) << "\"\n";
        }
        throw edm::Exception(errors::LogicError)
            << "Within a ParameterSetDescription, the type used for a wildcard must\n"
            << "not be the same as the type used for other parameters. This rule\n"
            << "is violated for the following types:\n"
            << ss.str() << "\n";
      }
    }
 
    if (!typesUsedForWildcards_.empty()) {
      std::set<ParameterTypes> duplicateTypes2;
      std::insert_iterator<std::set<ParameterTypes> > insertIter2(duplicateTypes2, duplicateTypes2.begin());
      std::set_intersection(typesUsedForWildcards_.begin(),
                            typesUsedForWildcards_.end(),
                            nodeParameterTypes.begin(),
                            nodeParameterTypes.end(),
                            insertIter2);
 
      if (!duplicateTypes2.empty()) {
        std::stringstream ss;
        for (std::set<ParameterTypes>::const_iterator iter = duplicateTypes2.begin(), iEnd = duplicateTypes2.end();
             iter != iEnd;
             ++iter) {
          ss << " \"" << parameterTypeEnumToString(*iter) << "\"\n";
        }
        throw edm::Exception(errors::LogicError)
            << "Within a ParameterSetDescription, the type used for a wildcard must\n"
            << "not be the same as the type used for other parameters. This rule is\n"
            << "violated for the following types :\n"
            << ss.str() << "\n";
      }
    }
 
    typesUsedForParameters_.insert(nodeParameterTypes.begin(), nodeParameterTypes.end());
    typesUsedForWildcards_.insert(nodeWildcardTypes.begin(), nodeWildcardTypes.end());
  }

References Exception, edm::errors::LogicError, edm::parameterTypeEnumToString(), contentValuesCheck::ss, typesUsedForParameters_, and typesUsedForWildcards_.

Referenced by addNode().

throwIllegalParameters()

void ParameterSetDescription::throwIllegalParameters ( std::vector< std::string > const &  parameterNames, std::set< std::string > const &  validatedNames  )

staticprivate

Definition at line 195 of file ParameterSetDescription.cc.

                                                                                                 {
    std::set<std::string> parNames(parameterNames.begin(), parameterNames.end());
 
    std::set<std::string> diffNames;
    std::insert_iterator<std::set<std::string> > insertIter(diffNames, diffNames.begin());
    std::set_difference(parNames.begin(), parNames.end(), validatedLabels.begin(), validatedLabels.end(), insertIter);
 
    std::stringstream ss;
    for (std::set<std::string>::const_iterator iter = diffNames.begin(), iEnd = diffNames.end(); iter != iEnd; ++iter) {
      ss << " '" << *iter << "'\n";
    }
    if (diffNames.size() == 1U) {
      throw edm::Exception(errors::Configuration)
          << "Illegal parameter found in configuration.  The parameter is named:\n"
          << ss.str() << "You could be trying to use a parameter name that is not\n"
          << "allowed for this plugin or it could be misspelled.\n";
    } else {
      throw edm::Exception(errors::Configuration)
          << "Illegal parameters found in configuration.  The parameters are named:\n"
          << ss.str() << "You could be trying to use parameter names that are not\n"
          << "allowed for this plugin or they could be misspelled.\n";
    }
  }

References edm::errors::Configuration, Exception, HcalResponse_cfi::parNames, contentValuesCheck::ss, and mitigatedMETSequence_cff::U.

Referenced by validate().

validate()

void ParameterSetDescription::validate

(

ParameterSet &

pset

)

const

Definition at line 78 of file ParameterSetDescription.cc.

                                                                 {
    using std::placeholders::_1;
    if (unknown_)
      return;
 
    std::set<std::string> validatedLabels;
    for_all(entries_, std::bind(&ParameterSetDescription::validateNode, _1, std::ref(pset), std::ref(validatedLabels)));
 
    std::vector<std::string> parameterNames = pset.getParameterNames();
    if (validatedLabels.size() != parameterNames.size()) {
      // Three labels will be magically inserted into the top level
      // of a module ParameterSet even though they are not in the
      // python configuration files.  If these are present, then
      // assume they are OK and count them as validated.
 
      std::string module_label("@module_label");
      if (pset.exists(module_label)) {
        validatedLabels.insert(module_label);
      }
 
      std::string module_type("@module_type");
      if (pset.exists(module_type)) {
        validatedLabels.insert(module_type);
      }
 
      std::string module_edm_type("@module_edm_type");
      if (pset.exists(module_edm_type)) {
        validatedLabels.insert(module_edm_type);
      }
 
      std::string service_type("@service_type");
      if (pset.exists(service_type)) {
        validatedLabels.insert(service_type);
      }
 
      // Try again
      if (validatedLabels.size() != parameterNames.size()) {
        if (IllegalParameters::throwAnException() && !anythingAllowed()) {
          throwIllegalParameters(parameterNames, validatedLabels);
        }
      }
    }
  }

References anythingAllowed(), entries_, edm::for_all(), muonDTDigis_cfi::pset, AlCaHLTBitMon_QueryRunRegistry::string, edm::IllegalParameters::throwAnException(), throwIllegalParameters(), unknown_, and validateNode().

Referenced by edm::ConfigurationDescriptions::validate(), and edm::ParameterWildcardWithSpecifics::validateDescription().

validateNode()

void ParameterSetDescription::validateNode ( SetDescriptionEntry const &  entry, ParameterSet &  pset, std::set< std::string > &  validatedNames  )

staticprivate

Definition at line 140 of file ParameterSetDescription.cc.

                                                                                 {
    entry.node()->validate(pset, validatedLabels, entry.optional());
  }

References mps_splice::entry, and muonDTDigis_cfi::pset.

Referenced by validate().

writeCfi()

void ParameterSetDescription::writeCfi	(	std::ostream &	os,
		bool	startWithComma,
		int	indentation
	)		const

Definition at line 122 of file ParameterSetDescription.cc.

                                                                                                   {
    using std::placeholders::_1;
    bool wroteSomething = false;
 
    for_all(entries_,
            std::bind(&ParameterSetDescription::writeNode,
                      _1,
                      std::ref(os),
                      std::ref(startWithComma),
                      indentation,
                      std::ref(wroteSomething)));
 
    if (wroteSomething) {
      char oldFill = os.fill();
      os << "\n" << std::setfill(' ') << std::setw(indentation - 2) << "" << std::setfill(oldFill);
    }
  }

References entries_, edm::for_all(), printContent_cfi::indentation, and writeNode().

Referenced by edm::ParameterDescription< std::vector< ParameterSet > >::writeOneElementToCfi().

writeNode()

void ParameterSetDescription::writeNode ( SetDescriptionEntry const &  entry, std::ostream &  os, bool &  startWithComma, int  indentation, bool &  wroteSomething  )

staticprivate

Definition at line 220 of file ParameterSetDescription.cc.

                                                                                                                     {
    if (entry.writeToCfi()) {
      entry.node()->writeCfi(os, entry.optional(), startWithComma, indentation, wroteSomething);
    }
  }

References mps_splice::entry, and printContent_cfi::indentation.

Referenced by writeCfi().

Member Data Documentation

anythingAllowed_

bool edm::ParameterSetDescription::anythingAllowed_

private

Definition at line 371 of file ParameterSetDescription.h.

Referenced by anythingAllowed(), and setAllowAnything().

comment_

std::string edm::ParameterSetDescription::comment_

private

Definition at line 379 of file ParameterSetDescription.h.

Referenced by comment(), and setComment().

entries_

SetDescriptionEntries edm::ParameterSetDescription::entries_

private

Definition at line 373 of file ParameterSetDescription.h.

Referenced by addNode(), begin(), end(), print(), reserve(), validate(), and writeCfi().

typesUsedForParameters_

std::set<ParameterTypes> edm::ParameterSetDescription::typesUsedForParameters_

private

Definition at line 376 of file ParameterSetDescription.h.

Referenced by throwIfWildcardCollision().

typesUsedForWildcards_

std::set<ParameterTypes> edm::ParameterSetDescription::typesUsedForWildcards_

private

Definition at line 377 of file ParameterSetDescription.h.

Referenced by throwIfWildcardCollision().

unknown_

bool edm::ParameterSetDescription::unknown_

private

Definition at line 372 of file ParameterSetDescription.h.

Referenced by isUnknown(), setUnknown(), and validate().

usedLabels_

std::set<std::string> edm::ParameterSetDescription::usedLabels_

private

Definition at line 375 of file ParameterSetDescription.h.

Referenced by isLabelUnused(), and throwIfLabelsAlreadyUsed().