Config.Process Class Reference

Inheritance diagram for Config.Process:

Public Member Functions
def	__delattr__
def	__init__
def	__setattr__
def	__setstate__
def	add_
def	addSubProcess
def	aliases_
def	analyzerNames
def	analyzers_
def	dumpConfig
def	dumpPython
def	endpaths_
def	es_prefers_
def	es_producers_
def	es_sources_
def	extend
def	fillProcessDesc
def	filterNames
def	filters_
def	globalReplace
def	load
def	looper_
def	name_
def	outputModules_
def	pathNames
def	paths_
def	prefer
def	producerNames
def	producers_
def	prune
def	psets_
def	schedule_
def	sequences_
def	services_
def	setLooper_
def	setName_
def	setPartialSchedule_
def	setSchedule_
def	setSource_
def	setStrict
def	source_
def	subProcesses_
def	validate
def	vpsets_

Properties
	aliases = property(aliases_,doc="dictionary containing the aliases for the process")
	analyzers = property(analyzers_,doc="dictionary containing the analyzers for the process")
	endpaths = property(endpaths_,doc="dictionary containing the endpaths for the process")
	es_prefers = property(es_prefers_,doc="dictionary containing the es_prefers for the process")
	es_producers = property(es_producers_,doc="dictionary containing the es_producers for the process")
	es_sources = property(es_sources_,doc="dictionary containing the es_sources for the process")
	filters = property(filters_, doc="dictionary containing the filters for the process")
	looper = property(looper_,setLooper_,doc='the main looper or None if not set')
	outputModules = property(outputModules_,doc="dictionary containing the output_modules for the process")
	paths = property(paths_,doc="dictionary containing the paths for the process")
	process = property(name_,setName_, doc="name of the process")
	producers = property(producers_,doc="dictionary containing the producers for the process")
	psets = property(psets_,doc="dictionary containing the PSets for the process")
	schedule = property(schedule_,setSchedule_,doc='the schedule or None if not set')
	sequences = property(sequences_,doc="dictionary containing the sequences for the process")
	services = property(services_,doc="dictionary containing the services for the process")
	source = property(source_,setSource_,doc='the main source or None if not set')
	subProcesses = property(subProcesses_,doc='the SubProcesses that have been added to the Process')
	vpsets = property(vpsets_,doc="dictionary containing the PSets for the process")

Private Member Functions
def	__findFirstSequenceUsingModule
def	__setObjectLabel
def	_dumpConfigESPrefers
def	_dumpConfigNamedList
def	_dumpConfigOptionallyNamedList
def	_dumpConfigUnnamedList
def	_dumpPython
def	_dumpPythonList
def	_dumpPythonSubProcesses
def	_findPreferred
def	_insertInto
def	_insertManyInto
def	_insertOneInto
def	_insertPaths
def	_insertSubProcessesInto
def	_okToPlace
def	_place
def	_placeAlias
def	_placeAnalyzer
def	_placeEndPath
def	_placeESPrefer
def	_placeESProducer
def	_placeESSource
def	_placeFilter
def	_placeLooper
def	_placeOutputModule
def	_placePath
def	_placeProducer
def	_placePSet
def	_placeSequence
def	_placeService
def	_placeSource
def	_placeSubProcess
def	_placeVPSet
def	_pruneModules
def	_replaceInSequences
def	_sequencesInDependencyOrder
def	_validateSequence

Private Attributes
	__isStrict
	__ppset
	__process
	__processPSet
	__thelist

Detailed Description

Root class for a CMS configuration process

Definition at line 99 of file Config.py.

Constructor & Destructor Documentation

def Config.Process.__init__	(		self,
			name,
			Mods
	)

The argument 'name' will be the name applied to this Process
    Can optionally pass as additional arguments cms.Modifier instances
    that will be used to modify the Process as it is built

Definition at line 101 of file Config.py.

Member Function Documentation

def Config.Process.__delattr__	(		self,
			name
	)

Definition at line 387 of file Config.py.

def Config.Process.__findFirstSequenceUsingModule (   self,   seqs,   mod  )

private

Given a container of sequences, find the first sequence containing mod
and return the sequence. If no sequence is found, return None

Definition at line 376 of file Config.py.

def Config.Process.__setattr__	(		self,
			name,
			value
	)

Definition at line 298 of file Config.py.

def Config.Process.__setObjectLabel (   self,   object,   newLabel  )

private

Definition at line 271 of file Config.py.

def Config.Process.__setstate__	(		self,
			pkldict
	)

Unpickling hook.

Since cloneToObjectDict stores a hash of objects by their
id() it needs to be updated when unpickling to use the
new object id values instantiated during the unpickle.

Definition at line 154 of file Config.py.

def Config.Process._dumpConfigESPrefers (   self,   options  )

private

Definition at line 643 of file Config.py.

def Config.Process._dumpConfigNamedList (   self,   items,   typeName,   options  )

private

Definition at line 564 of file Config.py.

def Config.Process._dumpConfigOptionallyNamedList (   self,   items,   typeName,   options  )

private

Definition at line 574 of file Config.py.

def Config.Process._dumpConfigUnnamedList (   self,   items,   typeName,   options  )

private

Definition at line 569 of file Config.py.

def Config.Process._dumpPython (   self,   d,   options  )

private

Definition at line 702 of file Config.py.

def Config.Process._dumpPythonList (   self,   d,   options  )

private

Definition at line 653 of file Config.py.

def Config.Process._dumpPythonSubProcesses (   self,   l,   options  )

private

Definition at line 648 of file Config.py.

def Config.Process._findPreferred (   self,   esname,   d,   args,   kargs  )

private

Definition at line 978 of file Config.py.

def Config.Process._insertInto (   self,   parameterSet,   itemDict  )

private

Definition at line 750 of file Config.py.

def Config.Process._insertManyInto (   self,   parameterSet,   label,   itemDict,   tracked  )

private

Definition at line 760 of file Config.py.

def Config.Process._insertOneInto (   self,   parameterSet,   label,   item,   tracked  )

private

Definition at line 753 of file Config.py.

def Config.Process._insertPaths (   self,   processPSet  )

private

Definition at line 782 of file Config.py.

def Config.Process._insertSubProcessesInto (   self,   parameterSet,   label,   itemList,   tracked  )

private

Definition at line 769 of file Config.py.

def Config.Process._okToPlace (   self,   name,   mod,   d  )

private

Definition at line 422 of file Config.py.

def Config.Process._place (   self,   name,   mod,   d  )

private

Definition at line 443 of file Config.py.

def Config.Process._placeAlias (   self,   name,   mod  )

private

Definition at line 482 of file Config.py.

def Config.Process._placeAnalyzer (   self,   name,   mod  )

private

Definition at line 457 of file Config.py.

def Config.Process._placeEndPath (   self,   name,   mod  )

private

Definition at line 466 of file Config.py.

def Config.Process._placeESPrefer (   self,   name,   mod  )

private

Definition at line 478 of file Config.py.

def Config.Process._placeESProducer (   self,   name,   mod  )

private

Definition at line 476 of file Config.py.

def Config.Process._placeESSource (   self,   name,   mod  )

private

Definition at line 480 of file Config.py.

def Config.Process._placeFilter (   self,   name,   mod  )

private

Definition at line 455 of file Config.py.

def Config.Process._placeLooper (   self,   name,   mod  )

private

Definition at line 496 of file Config.py.

def Config.Process._placeOutputModule (   self,   name,   mod  )

private

Definition at line 451 of file Config.py.

def Config.Process._placePath (   self,   name,   mod  )

private

Definition at line 459 of file Config.py.

def Config.Process._placeProducer (   self,   name,   mod  )

private

Definition at line 453 of file Config.py.

def Config.Process._placePSet (   self,   name,   mod  )

private

Definition at line 484 of file Config.py.

def Config.Process._placeSequence (   self,   name,   mod  )

private

Definition at line 473 of file Config.py.

def Config.Process._placeService (   self,   typeName,   mod  )

private

Definition at line 506 of file Config.py.

def Config.Process._placeSource (   self,   name,   mod  )

private

Allow the source to be referenced by 'source' or by type name

Definition at line 488 of file Config.py.

def Config.Process._placeSubProcess (   self,   name,   mod  )

private

Definition at line 501 of file Config.py.

def Config.Process._placeVPSet (   self,   name,   mod  )

private

Definition at line 486 of file Config.py.

def Config.Process._pruneModules (   self,   d,   scheduledNames  )

private

Definition at line 878 of file Config.py.

def Config.Process._replaceInSequences (   self,   label,   new  )

private

Definition at line 735 of file Config.py.

def Config.Process._sequencesInDependencyOrder (   self )

private

Definition at line 670 of file Config.py.

def Config.Process._validateSequence (   self,   sequence,   label  )

private

Definition at line 662 of file Config.py.

def Config.Process.add_	(		self,
			value
	)

Allows addition of components that do not have to have a label, e.g. Services

Definition at line 407 of file Config.py.

def Config.Process.addSubProcess	(		self,
			mod
	)

Definition at line 504 of file Config.py.

def Config.Process.aliases_

(

self

)

returns a dict of the aliases that have been added to the Process

Definition at line 258 of file Config.py.

def Config.Process.analyzerNames

(

self

)

Returns a string containing all the EDAnalyzer labels separated by a blank

Definition at line 144 of file Config.py.

def Config.Process.analyzers_

(

self

)

returns a dict of the analyzers that have been added to the Process

Definition at line 202 of file Config.py.

def Config.Process.dumpConfig	(		self,
			options = PrintOptions()
	)

return a string containing the equivalent process defined using the old configuration language

Definition at line 581 of file Config.py.

def Config.Process.dumpPython	(		self,
			options = PrintOptions()
	)

return a string containing the equivalent process defined using python

Definition at line 707 of file Config.py.

def Config.Process.endpaths_

(

self

)

returns a dict of the endpaths that have been added to the Process

Definition at line 214 of file Config.py.

def Config.Process.es_prefers_

(

self

)

returns a dict of the es_prefers that have been added to the Process

Definition at line 254 of file Config.py.

def Config.Process.es_producers_

(

self

)

returns a dict of the esproducers that have been added to the Process

Definition at line 246 of file Config.py.

def Config.Process.es_sources_

(

self

)

returns a the es_sources that have been added to the Process

Definition at line 250 of file Config.py.

def Config.Process.extend	(		self,
			other,
			items = ()
	)

Look in other and find types that we can use

Definition at line 513 of file Config.py.

def Config.Process.fillProcessDesc	(		self,
			processPSet
	)

Used by the framework to convert python to C++ objects

Definition at line 885 of file Config.py.

def Config.Process.filterNames

(

self

)

Returns a string containing all the EDFilter labels separated by a blank

Definition at line 147 of file Config.py.

def Config.Process.filters_

(

self

)

returns a dict of the filters that have been added to the Process

Definition at line 171 of file Config.py.

def Config.Process.globalReplace	(		self,
			label,
			new
	)

Replace the item with label 'label' by object 'new' in the process and all sequences/paths

Definition at line 744 of file Config.py.

def Config.Process.load	(		self,
			moduleName
	)

Definition at line 509 of file Config.py.

def Config.Process.looper_

(

self

)

returns the looper that has been added to the Process or None if none have been added

Definition at line 192 of file Config.py.

def Config.Process.name_

(

self

)

Definition at line 175 of file Config.py.

def Config.Process.outputModules_

(

self

)

returns a dict of the output modules that have been added to the Process

Definition at line 206 of file Config.py.

def Config.Process.pathNames

(

self

)

Returns a string containing all the Path names separated by a blank

Definition at line 150 of file Config.py.

def Config.Process.paths_

(

self

)

returns a dict of the paths that have been added to the Process

Definition at line 210 of file Config.py.

def Config.Process.prefer	(		self,
			esmodule,
			args,
			kargs
	)

Prefer this ES source or producer.  The argument can
   either be an object label, e.g.,
     process.prefer(process.juicerProducer) (not supported yet)
   or a name of an ESSource or ESProducer
     process.prefer("juicer")
   or a type of unnamed ESSource or ESProducer
     process.prefer("JuicerProducer")
   In addition, you can pass as a labelled arguments the name of the Record you wish to
   prefer where the type passed is a cms.vstring and that vstring can contain the
   name of the C++ types in the Record that are being preferred, e.g.,
      #prefer all data in record 'OrangeRecord' from 'juicer'
      process.prefer("juicer", OrangeRecord=cms.vstring())
   or
      #prefer only "Orange" data in "OrangeRecord" from "juicer"
      process.prefer("juicer", OrangeRecord=cms.vstring("Orange"))
   or
      #prefer only "Orange" data with label "ExtraPulp" in "OrangeRecord" from "juicer"
      ESPrefer("ESJuicerProd", OrangeRecord=cms.vstring("Orange/ExtraPulp"))

Definition at line 949 of file Config.py.

def Config.Process.producerNames

(

self

)

Returns a string containing all the EDProducer labels separated by a blank

Definition at line 141 of file Config.py.

def Config.Process.producers_

(

self

)

returns a dict of the producers that have been added to the Process

Definition at line 182 of file Config.py.

def Config.Process.prune	(		self,
			verbose = False,
			keepUnresolvedSequencePlaceholders = False
	)

Remove clutter from the process that we think is unnecessary:
tracked PSets, VPSets and unused modules and sequences. If a Schedule has been set, then Paths and EndPaths
not in the schedule will also be removed, along with an modules and sequences used only by
those removed Paths and EndPaths.

Definition at line 823 of file Config.py.

def Config.Process.psets_

(

self

)

returns a dict of the PSets that have been added to the Process

Definition at line 262 of file Config.py.

def Config.Process.schedule_

(

self

)

returns the schedule that has been added to the Process or None if none have been added

Definition at line 222 of file Config.py.

def Config.Process.sequences_

(

self

)

returns a dict of the sequences that have been added to the Process

Definition at line 218 of file Config.py.

def Config.Process.services_

(

self

)

returns a dict of the services that have been added to the Process

Definition at line 242 of file Config.py.

def Config.Process.setLooper_	(		self,
			lpr
	)

Definition at line 195 of file Config.py.

def Config.Process.setName_	(		self,
			name
	)

Definition at line 177 of file Config.py.

def Config.Process.setPartialSchedule_	(		self,
			sch,
			label
	)

Definition at line 225 of file Config.py.

def Config.Process.setSchedule_	(		self,
			sch
	)

Definition at line 230 of file Config.py.

def Config.Process.setSource_	(		self,
			src
	)

Definition at line 189 of file Config.py.

def Config.Process.setStrict	(		self,
			value
	)

Definition at line 136 of file Config.py.

def Config.Process.source_

(

self

)

returns the source that has been added to the Process or None if none have been added

Definition at line 186 of file Config.py.

def Config.Process.subProcesses_

(

self

)

returns a list of the subProcesses that have been added to the Process

Definition at line 198 of file Config.py.

def Config.Process.validate

(

self

)

Definition at line 942 of file Config.py.

def Config.Process.vpsets_

(

self

)

returns a dict of the VPSets that have been added to the Process

Definition at line 266 of file Config.py.

Member Data Documentation

Config.Process.__isStrict

private

Definition at line 131 of file Config.py.

Config.Process.__ppset

private

Definition at line 900 of file Config.py.

Config.Process.__process

private

Definition at line 901 of file Config.py.

Config.Process.__processPSet

private

Definition at line 890 of file Config.py.

Config.Process.__thelist

private

Definition at line 889 of file Config.py.

Property Documentation

Config.Process.aliases = property(aliases_,doc="dictionary containing the aliases for the process")

static

Definition at line 261 of file Config.py.

Config.Process.analyzers = property(analyzers_,doc="dictionary containing the analyzers for the process")

static

Definition at line 205 of file Config.py.

Config.Process.endpaths = property(endpaths_,doc="dictionary containing the endpaths for the process")

static

Definition at line 217 of file Config.py.

Config.Process.es_prefers = property(es_prefers_,doc="dictionary containing the es_prefers for the process")

static

Definition at line 257 of file Config.py.

Config.Process.es_producers = property(es_producers_,doc="dictionary containing the es_producers for the process")

static

Definition at line 249 of file Config.py.

Config.Process.es_sources = property(es_sources_,doc="dictionary containing the es_sources for the process")

static

Definition at line 253 of file Config.py.

Config.Process.filters = property(filters_, doc="dictionary containing the filters for the process")

static

Definition at line 174 of file Config.py.

Config.Process.looper = property(looper_,setLooper_,doc='the main looper or None if not set')

static

Definition at line 197 of file Config.py.

Config.Process.outputModules = property(outputModules_,doc="dictionary containing the output_modules for the process")

static

Definition at line 209 of file Config.py.

Config.Process.paths = property(paths_,doc="dictionary containing the paths for the process")

static

Definition at line 213 of file Config.py.

Config.Process.process = property(name_,setName_, doc="name of the process")

static

Definition at line 181 of file Config.py.

Config.Process.producers = property(producers_,doc="dictionary containing the producers for the process")

static

Definition at line 185 of file Config.py.

Config.Process.psets = property(psets_,doc="dictionary containing the PSets for the process")

static

Definition at line 265 of file Config.py.

Config.Process.schedule = property(schedule_,setSchedule_,doc='the schedule or None if not set')

static

Definition at line 241 of file Config.py.

Config.Process.sequences = property(sequences_,doc="dictionary containing the sequences for the process")

static

Definition at line 221 of file Config.py.

Config.Process.services = property(services_,doc="dictionary containing the services for the process")

static

Definition at line 245 of file Config.py.

Config.Process.source = property(source_,setSource_,doc='the main source or None if not set')

static

Definition at line 191 of file Config.py.

Config.Process.subProcesses = property(subProcesses_,doc='the SubProcesses that have been added to the Process')

static

Definition at line 201 of file Config.py.

Config.Process.vpsets = property(vpsets_,doc="dictionary containing the PSets for the process")

static

Definition at line 269 of file Config.py.