Mixins._Labelable Class Reference

Inheritance diagram for Mixins._Labelable:

Public Member Functions
def	__str__ (self)
def	dumpSequenceConfig (self)
def	dumpSequencePython (self, options=PrintOptions())
def	hasLabel_ (self)
def	label (self)
def	label_ (self)
def	setLabel (self, label)

Private Member Functions
def	_findDependencies (self, knownDeps, presentDeps)

Private Attributes
	__label

Detailed Description

A 'mixin' used to denote that the class can be paired with a label (e.g. an EDProducer)

Definition at line 487 of file Mixins.py.

Member Function Documentation

def Mixins._Labelable.__str__

(

self

)

Definition at line 516 of file Mixins.py.

References Mixins._Labelable.__label, and str.

    def __str__(self):
        #this is probably a bad idea
        # I added this so that when we ask a path to print
        # we will see the label that has been assigned
        return str(self.__label)

def Mixins._Labelable._findDependencies (   self,   knownDeps,   presentDeps  )

private

Definition at line 525 of file Mixins.py.

References CTPPSPixelDAQMappingAnalyzer.label_, XMLIdealGeometryESProducer.label_, Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigFolder.label_(), edm::eventsetup::ComponentDescription.label_, SiStripLorentzAngleReader.label_, XMLIdealMagneticFieldGeometryESProducer.label_, StripSubClusterShapeFilterBase.label_, ESDigiToRaw.label_, pat::TriggerFilter.label_, HistoProviderDQM.label_, RetrieveCTPPSBeamParameters.label_, CTPPSPixelRawToDigi.label_, VertexCompositeCandidateCollectionSelector.label_, WriteCTPPSPixelAnalysisMask.label_, WriteCTPPSPixelDAQMapping.label_, edm::ESOutlet< T, TRec >::Getter.label_, VertexMonitor.label_, RawEventOutputModuleForBU< Consumer >.label_, PythiaFilterHT.label_, RandomEngineState.label_, EffPurFromHistos2D.label_, PythiaMomDauFilter.label_, edm::ConsumesInfo.label_, SiPixelStatusManager.label_, edm::InputTag.label_, SiPixelStatusHarvester.label_, edm::SecSourceAnalyzer.label_, TPGCheck.label_, reco::Centrality.label_, pat::helper::AnyNumberAssociationAdaptor.label_, EcalTrigPrimAnalyzer.label_, EffPurFromHistos.label_, edm::test::Run.label_, pat::TauJetCorrFactors.label_, edm::test::LuminosityBlock.label_, edm::test::Event.label_, edm::DataMixingSiStripWorker.label_, edm::DataMixingSiPixelWorker.label_, StallStatistics.label_, edm::DataMixingPileupCopy.label_, SiPixelCalibDigiProducer.label_, edm::DataMixingSiStripRawWorker.label_, edm::HiMixingWorkerBase.label_, edm::ParameterDescriptionBase.label_, HLTOfflineDQMTopSingleLepton::MonitorSingleLepton.label_, fwlite::ObjectCountSelector< Collection >.label_, PileupJetIdAlgo::AlgoGBRForestsAndConstants.label_, npstat::UniformAxis.label_, HLTOfflineDQMTopDiLepton::MonitorDiLepton.label_, edm::DataMixingEMWorker.label_, pat::JetCorrFactors.label_, edm::DataMixingHcalWorker.label_, TopSingleLepton_miniAOD::MonitorEnsemble.label_, edm::DataMixingHcalDigiWorkerProd.label_, SingleTopTChannelLepton_miniAOD::MonitorEnsemble.label_, pat::JetCorrFactorsProducer.label_, edm::DataMixingEMDigiWorker.label_, edm::DataMixingMuonWorker.label_, edm::messagedrop::StringProducerWithPhase.label_, npstat::NUHistoAxis.label_, edm::DataMixingHcalDigiWorker.label_, TopSingleLepton::MonitorEnsemble.label_, SingleTopTChannelLepton::MonitorEnsemble.label_, HLTObjectsMonitor.label_, npstat::GridAxis.label_, SummaryGenerator.label_, npstat::HistoAxis.label_, TopDiLeptonOffline::MonitorEnsemble.label_, edm::service::RandomNumberGeneratorService::LabelAndEngine.label_, edm::MixingWorker< T >.label_, edm::DataMixingModule.label_, Mixins._Labelable.label_(), fwlite::Scanner< Collection >.label_, and str.

    def _findDependencies(self,knownDeps,presentDeps):
        #print 'in labelled'
        myDeps=knownDeps.get(self.label_(),None)
        if myDeps!=None:
            if presentDeps != myDeps:
                raise RuntimeError("the module "+self.label_()+" has two dependencies \n"
                                   +str(presentDeps)+"\n"
                                   +str(myDeps)+"\n"
                                   +"Please modify sequences to rectify this inconsistency")
        else:
            myDeps=set(presentDeps)
            knownDeps[self.label_()]=myDeps
        presentDeps.add(self.label_())

def Mixins._Labelable.dumpSequenceConfig

(

self

)

Definition at line 521 of file Mixins.py.

References Mixins._Labelable.__label, and str.

    def dumpSequenceConfig(self):
        return str(self.__label)

def Mixins._Labelable.dumpSequencePython	(		self,
			options = PrintOptions()
	)

Definition at line 523 of file Mixins.py.

References Mixins._Labelable.__label, and str.

    def dumpSequencePython(self, options=PrintOptions()):
        return 'process.'+str(self.__label)

def Mixins._Labelable.hasLabel_

(

self

)

Definition at line 493 of file Mixins.py.

References Mixins._Labelable.__label.

Referenced by SequenceTypes._ModuleSequenceType.dumpSequenceConfig(), SequenceTypes._ModuleSequenceType.dumpSequencePython(), SequenceTypes.Task.fillContents(), and Mixins._Labelable.setLabel().

    def hasLabel_(self):
        return hasattr(self, "_Labelable__label") and self.__label is not None

def Mixins._Labelable.label

(

self

)

Definition at line 513 of file Mixins.py.

References Mixins._Labelable.__label.

    def label(self):
        #print "WARNING: _Labelable::label() needs to be changed to label_()"
        return self.__label

def Mixins._Labelable.label_

(

self

)

Definition at line 489 of file Mixins.py.

References Mixins._Labelable.__label.

Referenced by SequenceTypes.DummyModule.__repr__(), Mixins._Labelable._findDependencies(), and Mixins._Labelable.setLabel().

    def label_(self):
        if not hasattr(self, "_Labelable__label"):
           raise RuntimeError("module has no label.  Perhaps it wasn't inserted into the process?")
        return self.__label

def Mixins._Labelable.setLabel	(		self,
			label
	)

Definition at line 495 of file Mixins.py.

References Mixins._Labelable.hasLabel_(), CTPPSPixelDAQMappingAnalyzer.label_, XMLIdealGeometryESProducer.label_, Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigFolder.label_(), edm::eventsetup::ComponentDescription.label_, SiStripLorentzAngleReader.label_, XMLIdealMagneticFieldGeometryESProducer.label_, StripSubClusterShapeFilterBase.label_, ESDigiToRaw.label_, pat::TriggerFilter.label_, HistoProviderDQM.label_, CTPPSPixelRawToDigi.label_, RetrieveCTPPSBeamParameters.label_, VertexCompositeCandidateCollectionSelector.label_, WriteCTPPSPixelAnalysisMask.label_, WriteCTPPSPixelDAQMapping.label_, edm::ESOutlet< T, TRec >::Getter.label_, VertexMonitor.label_, RawEventOutputModuleForBU< Consumer >.label_, PythiaFilterHT.label_, RandomEngineState.label_, EffPurFromHistos2D.label_, PythiaMomDauFilter.label_, edm::ConsumesInfo.label_, SiPixelStatusManager.label_, SiPixelStatusHarvester.label_, edm::InputTag.label_, edm::SecSourceAnalyzer.label_, TPGCheck.label_, reco::Centrality.label_, pat::helper::AnyNumberAssociationAdaptor.label_, EcalTrigPrimAnalyzer.label_, EffPurFromHistos.label_, edm::test::Run.label_, pat::TauJetCorrFactors.label_, edm::test::LuminosityBlock.label_, edm::test::Event.label_, edm::DataMixingSiStripWorker.label_, edm::DataMixingSiPixelWorker.label_, StallStatistics.label_, edm::DataMixingPileupCopy.label_, SiPixelCalibDigiProducer.label_, edm::DataMixingSiStripRawWorker.label_, edm::HiMixingWorkerBase.label_, edm::ParameterDescriptionBase.label_, HLTOfflineDQMTopSingleLepton::MonitorSingleLepton.label_, PileupJetIdAlgo::AlgoGBRForestsAndConstants.label_, fwlite::ObjectCountSelector< Collection >.label_, npstat::UniformAxis.label_, HLTOfflineDQMTopDiLepton::MonitorDiLepton.label_, edm::DataMixingEMWorker.label_, pat::JetCorrFactors.label_, edm::DataMixingHcalWorker.label_, edm::DataMixingHcalDigiWorkerProd.label_, TopSingleLepton_miniAOD::MonitorEnsemble.label_, SingleTopTChannelLepton_miniAOD::MonitorEnsemble.label_, pat::JetCorrFactorsProducer.label_, edm::DataMixingEMDigiWorker.label_, edm::DataMixingMuonWorker.label_, edm::messagedrop::StringProducerWithPhase.label_, edm::DataMixingHcalDigiWorker.label_, npstat::NUHistoAxis.label_, TopSingleLepton::MonitorEnsemble.label_, SingleTopTChannelLepton::MonitorEnsemble.label_, HLTObjectsMonitor.label_, npstat::GridAxis.label_, SummaryGenerator.label_, npstat::HistoAxis.label_, TopDiLeptonOffline::MonitorEnsemble.label_, edm::service::RandomNumberGeneratorService::LabelAndEngine.label_, edm::MixingWorker< T >.label_, edm::DataMixingModule.label_, Mixins._Labelable.label_(), fwlite::Scanner< Collection >.label_, and str.

Referenced by SequenceTypes.DummyModule.__init__(), and SequenceTypes.DummyBooleanModule.__init__().

    def setLabel(self,label):
        if self.hasLabel_() :
            if self.label_() != label and label is not None :
                msg100 = "Attempting to change the label of a Labelable object, possibly an attribute of the Process\n"
                msg101 = "Old label = "+self.label_()+"  New label = "+label+"\n"
                msg102 = "Type = "+str(type(self))+"\n"
                msg103 = "Some possible solutions:\n"
                msg104 = "  1. Clone modules instead of using simple assignment. Cloning is\n"
                msg105 = "  also preferred for other types when possible.\n"
                msg106 = "  2. Declare new names starting with an underscore if they are\n"
                msg107 = "  for temporaries you do not want propagated into the Process. The\n"
                msg108 = "  underscore tells \"from x import *\" and process.load not to import\n"
                msg109 = "  the name.\n"
                msg110 = "  3. Reorganize so the assigment is not necessary. Giving a second\n"
                msg111 = "  name to the same object usually causes confusion and problems.\n"
                msg112 = "  4. Compose Sequences: newName = cms.Sequence(oldName)\n"
                raise ValueError(msg100+msg101+msg102+msg103+msg104+msg105+msg106+msg107+msg108+msg109+msg110+msg111+msg112)
        self.__label = label

Member Data Documentation

Mixins._Labelable.__label

private

Definition at line 512 of file Mixins.py.

Referenced by Mixins._Labelable.__str__(), Mixins._ValidatingListBase._labelIfAny(), Mixins._Labelable.dumpSequenceConfig(), Mixins._Labelable.dumpSequencePython(), SequenceVisitors.PathValidator.enter(), SequenceVisitors.EndPathValidator.enter(), Mixins._Labelable.hasLabel_(), Mixins._Labelable.label(), Mixins._Labelable.label_(), SequenceVisitors.PathValidator.setLabel(), and SequenceVisitors.EndPathValidator.setLabel().