CMS 3D CMS Logo
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Public Member Functions | Private Member Functions | Private Attributes
Mixins._Labelable Class Reference
Inheritance diagram for Mixins._Labelable:
Modules._Module Modules.ESPrefer Modules.ESProducer Modules.ESSource SequenceTypes._ModuleSequenceType SequenceTypes.DummyBooleanModule SequenceTypes.DummyModule Types.EDAlias Types.PSet Types.SecSource Types.VPSet

Public Member Functions

def __str__
 
def dumpSequenceConfig
 
def dumpSequencePython
 
def hasLabel_
 
def label
 
def label_
 
def setLabel
 

Private Member Functions

def _findDependencies
 

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 431 of file Mixins.py.

Member Function Documentation

def Mixins._Labelable.__str__ (   self)

Definition at line 460 of file Mixins.py.

References Mixins._Labelable.__label.

460 
461  def __str__(self):
462  #this is probably a bad idea
463  # I added this so that when we ask a path to print
464  # we will see the label that has been assigned
return str(self.__label)
Mixins._Labelable.__str__
def __str__
Definition: Mixins.py:460
Mixins._Labelable.__label
__label
Definition: Mixins.py:456
def Mixins._Labelable._findDependencies (   self,
  knownDeps,
  presentDeps 
)
private

Definition at line 469 of file Mixins.py.

References evf::EvFRecordUnpacker.label_, evf::EvFRecordInserter.label_, Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigFolder.label_(), edm::eventsetup::ComponentDescription.label_, SiStripLorentzAngleReader.label_, XMLIdealMagneticFieldGeometryESProducer.label_, StripSubClusterShapeFilterBase.label_, pat::TriggerFilter.label_, HistoProviderDQM.label_, MuonNumberingInitialization.label_, RawEventOutputModuleForBU< Consumer >.label_, edm::ESOutlet< T, TRec >::Getter.label_, PythiaFilterHT.label_, EffPurFromHistos2D.label_, reco::Centrality.label_, VertexMonitor.label_, PythiaMomDauFilter.label_, RandomEngineState.label_, ESDigiToRaw.label_, edm::InputTag.label_, edm::ConsumesInfo.label_, edm::SecSourceAnalyzer.label_, TPGCheck.label_, XMLIdealGeometryESProducer.label_, EcalTrigPrimAnalyzer.label_, pat::helper::AnyNumberAssociationAdaptor.label_, EffPurFromHistos.label_, pat::TauJetCorrFactors.label_, edm::DataMixingPileupCopy.label_, edm::DataMixingSiPixelWorker.label_, edm::DataMixingSiStripWorker.label_, edm::DataMixingSiStripRawWorker.label_, SiPixelCalibDigiProducer.label_, edm::HiMixingWorkerBase.label_, HLTOfflineDQMTopSingleLepton::MonitorSingleLepton.label_, fwlite::ObjectCountSelector< Collection >.label_, npstat::UniformAxis.label_, HLTOfflineDQMTopDiLepton::MonitorDiLepton.label_, pat::JetCorrFactors.label_, SingleTopTChannelLepton_miniAOD::MonitorEnsemble.label_, edm::DataMixingHcalWorker.label_, edm::DataMixingHcalDigiWorkerProd.label_, TopSingleLepton_miniAOD::MonitorEnsemble.label_, edm::DataMixingEcalDigiWorkerProd.label_, edm::DataMixingEMWorker.label_, pat::JetCorrFactorsProducer.label_, edm::ParameterDescriptionBase.label_, EcalDigiToRaw.label_, edm::DataMixingMuonWorker.label_, edm::DataMixingEMDigiWorker.label_, edm::DataMixingHcalDigiWorker.label_, edm::DataMixingSiStripMCDigiWorker.label_, npstat::NUHistoAxis.label_, TopSingleLepton::MonitorEnsemble.label_, SingleTopTChannelLepton::MonitorEnsemble.label_, edm::messagedrop::StringProducerWithPhase.label_, npstat::GridAxis.label_, edm::service::RandomNumberGeneratorService::LabelAndEngine.label_, SummaryGenerator.label_, TopDiLeptonOffline::MonitorEnsemble.label_, npstat::HistoAxis.label_, edm::DataMixingSiPixelMCDigiWorker.label_, edm::MixingWorker< T >.label_, edm::DataMixingModule.label_, Mixins._Labelable.label_(), and fwlite::Scanner< Collection >.label_.

469 
470  def _findDependencies(self,knownDeps,presentDeps):
471  #print 'in labelled'
472  myDeps=knownDeps.get(self.label_(),None)
473  if myDeps!=None:
474  if presentDeps != myDeps:
475  raise RuntimeError("the module "+self.label_()+" has two dependencies \n"
476  +str(presentDeps)+"\n"
477  +str(myDeps)+"\n"
478  +"Please modify sequences to rectify this inconsistency")
479  else:
480  myDeps=set(presentDeps)
481  knownDeps[self.label_()]=myDeps
482  presentDeps.add(self.label_())
483 
Mixins._Labelable.label_
def label_
Definition: Mixins.py:433
Mixins._Labelable._findDependencies
def _findDependencies
Definition: Mixins.py:469
def Mixins._Labelable.dumpSequenceConfig (   self)

Definition at line 465 of file Mixins.py.

References Mixins._Labelable.__label.

465 
466  def dumpSequenceConfig(self):
return str(self.__label)
Mixins._Labelable.dumpSequenceConfig
def dumpSequenceConfig
Definition: Mixins.py:465
Mixins._Labelable.__label
__label
Definition: Mixins.py:456
def Mixins._Labelable.dumpSequencePython (   self)

Definition at line 467 of file Mixins.py.

References Mixins._Labelable.__label.

467 
468  def dumpSequencePython(self):
return 'process.'+str(self.__label)
Mixins._Labelable.__label
__label
Definition: Mixins.py:456
Mixins._Labelable.dumpSequencePython
def dumpSequencePython
Definition: Mixins.py:467
def Mixins._Labelable.hasLabel_ (   self)

Definition at line 437 of file Mixins.py.

References Mixins._Labelable.__label.

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

437 
438  def hasLabel_(self):
return hasattr(self, "_Labelable__label") and self.__label is not None
Mixins._Labelable.hasLabel_
def hasLabel_
Definition: Mixins.py:437
Mixins._Labelable.__label
__label
Definition: Mixins.py:456
def Mixins._Labelable.label (   self)

Definition at line 457 of file Mixins.py.

References Mixins._Labelable.__label.

457 
458  def label(self):
459  #print "WARNING: _Labelable::label() needs to be changed to label_()"
return self.__label
Mixins._Labelable.label
def label
Definition: Mixins.py:457
Mixins._Labelable.__label
__label
Definition: Mixins.py:456
def Mixins._Labelable.label_ (   self)

Definition at line 433 of file Mixins.py.

References Mixins._Labelable.__label.

Referenced by Mixins._Labelable._findDependencies(), and Mixins._Labelable.setLabel().

433 
434  def label_(self):
435  if not hasattr(self, "_Labelable__label"):
436  raise RuntimeError("module has no label. Perhaps it wasn't inserted into the process?")
return self.__label
Mixins._Labelable.label_
def label_
Definition: Mixins.py:433
Mixins._Labelable.__label
__label
Definition: Mixins.py:456
def Mixins._Labelable.setLabel (   self,
  label 
)

Definition at line 439 of file Mixins.py.

References Mixins._Labelable.hasLabel_(), evf::EvFRecordUnpacker.label_, evf::EvFRecordInserter.label_, Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigFolder.label_(), edm::eventsetup::ComponentDescription.label_, SiStripLorentzAngleReader.label_, XMLIdealMagneticFieldGeometryESProducer.label_, StripSubClusterShapeFilterBase.label_, pat::TriggerFilter.label_, HistoProviderDQM.label_, MuonNumberingInitialization.label_, RawEventOutputModuleForBU< Consumer >.label_, edm::ESOutlet< T, TRec >::Getter.label_, PythiaFilterHT.label_, EffPurFromHistos2D.label_, reco::Centrality.label_, VertexMonitor.label_, PythiaMomDauFilter.label_, RandomEngineState.label_, ESDigiToRaw.label_, edm::InputTag.label_, edm::ConsumesInfo.label_, edm::SecSourceAnalyzer.label_, TPGCheck.label_, XMLIdealGeometryESProducer.label_, EcalTrigPrimAnalyzer.label_, pat::helper::AnyNumberAssociationAdaptor.label_, EffPurFromHistos.label_, pat::TauJetCorrFactors.label_, edm::DataMixingPileupCopy.label_, edm::DataMixingSiPixelWorker.label_, edm::DataMixingSiStripWorker.label_, edm::DataMixingSiStripRawWorker.label_, SiPixelCalibDigiProducer.label_, edm::HiMixingWorkerBase.label_, HLTOfflineDQMTopSingleLepton::MonitorSingleLepton.label_, fwlite::ObjectCountSelector< Collection >.label_, npstat::UniformAxis.label_, HLTOfflineDQMTopDiLepton::MonitorDiLepton.label_, SingleTopTChannelLepton_miniAOD::MonitorEnsemble.label_, pat::JetCorrFactors.label_, edm::DataMixingHcalWorker.label_, edm::DataMixingHcalDigiWorkerProd.label_, TopSingleLepton_miniAOD::MonitorEnsemble.label_, edm::DataMixingEcalDigiWorkerProd.label_, edm::DataMixingEMWorker.label_, pat::JetCorrFactorsProducer.label_, edm::ParameterDescriptionBase.label_, EcalDigiToRaw.label_, edm::DataMixingMuonWorker.label_, edm::DataMixingHcalDigiWorker.label_, edm::DataMixingEMDigiWorker.label_, edm::DataMixingSiStripMCDigiWorker.label_, npstat::NUHistoAxis.label_, TopSingleLepton::MonitorEnsemble.label_, SingleTopTChannelLepton::MonitorEnsemble.label_, edm::messagedrop::StringProducerWithPhase.label_, npstat::GridAxis.label_, edm::service::RandomNumberGeneratorService::LabelAndEngine.label_, SummaryGenerator.label_, TopDiLeptonOffline::MonitorEnsemble.label_, npstat::HistoAxis.label_, edm::DataMixingSiPixelMCDigiWorker.label_, edm::MixingWorker< T >.label_, edm::DataMixingModule.label_, Mixins._Labelable.label_(), and fwlite::Scanner< Collection >.label_.

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

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

Member Data Documentation

Mixins._Labelable.__label
private

Definition at line 456 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().

Generated for CMSSW Reference Manual by doxygen 1.8.5