Config.Modifier Class Reference

Inheritance diagram for Config.Modifier:

Public Member Functions
def	__and__
def	__init__
def	isChosen
def	makeProcessModifier
def	toModify
def	toReplaceWith

Private Member Functions
def	_setChosen

Private Attributes
	__chosen
	__processModifiers

Detailed Description

This class is used to define standard modifications to a Process.
An instance of this class is declared to denote a specific modification,e.g. era2017 could
reconfigure items in a process to match our expectation of running in 2017. Once declared,
these Modifier instances are imported into a configuration and items that need to be modified
are then associated with the Modifier and with the action to do the modification.
The registered modifications will only occur if the Modifier was passed to 
the cms.Process' constructor.

Definition at line 1147 of file Config.py.

Constructor & Destructor Documentation

def Config.Modifier.__init__

(

self

)

Definition at line 1156 of file Config.py.

Member Function Documentation

def Config.Modifier.__and__	(		self,
			other
	)

Definition at line 1213 of file Config.py.

def Config.Modifier._setChosen (   self )

private

Should only be called by cms.Process instances

Definition at line 1208 of file Config.py.

def Config.Modifier.isChosen

(

self

)

Definition at line 1211 of file Config.py.

def Config.Modifier.makeProcessModifier	(		self,
			func
	)

This is used to create a ProcessModifer that can perform actions on the process as a whole.
   This takes as argument a callable object (e.g. function) that takes as its sole argument an instance of Process.
   In order to work, the value returned from this function must be assigned to a uniquely named variable.

Definition at line 1159 of file Config.py.

def Config.Modifier.toModify	(		self,
			obj,
			func = None,
			kw
	)

This is used to register an action to be performed on the specific object. Two different forms are allowed
Form 1: A callable object (e.g. function) can be passed as the second. This callable object is expected to take one argument
that will be the object passed in as the first argument.
Form 2: A list of parameter name, value pairs can be passed
   mod.toModify(foo, fred=cms.int32(7), barney = cms.double(3.14))
This form can also be used to remove a parameter by passing the value of None
#remove the parameter foo.fred       
mod.toModify(foo, fred = None)
Additionally, parameters embedded within PSets can also be modified using a dictionary
#change foo.fred.pebbles to 3 and foo.fred.friend to "barney"
mod.toModify(foo, fred = dict(pebbles = 3, friend = "barney)) )

Definition at line 1165 of file Config.py.

def Config.Modifier.toReplaceWith	(		self,
			toObj,
			fromObj
	)

If the Modifier is chosen the internals of toObj will be associated with the internals of fromObj

Definition at line 1187 of file Config.py.

Member Data Documentation

Config.Modifier.__chosen

private

Definition at line 1158 of file Config.py.

Config.Modifier.__processModifiers

private

Definition at line 1157 of file Config.py.