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
Config.Modifier Class Reference
Inheritance diagram for Config.Modifier:

Public Member Functions

def __init__
 
def isChosen
 
def makeProcessModifier
 
def toModify
 

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 which 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 1082 of file Config.py.

Constructor & Destructor Documentation

def Config.Modifier.__init__ (   self)

Definition at line 1091 of file Config.py.

1092  def __init__(self):
self.__chosen = False

Member Function Documentation

def Config.Modifier._setChosen (   self)
private
Should only be called by cms.Process instances

Definition at line 1116 of file Config.py.

References Config.Modifier.__chosen.

1117  def _setChosen(self):
1118  """Should only be called by cms.Process instances"""
self.__chosen = True
def Config.Modifier.isChosen (   self)

Definition at line 1119 of file Config.py.

References Config.Modifier.__chosen.

Referenced by Config.Modifier.toModify().

1120  def isChosen(self):
1121  return self.__chosen
def Config.Modifier.makeProcessModifier (   self,
  func 
)
This is used to create a ProcessModifer which can perform actions on the process as a whole.
   This takes as argument a callable object (e.g. function) which 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 1094 of file Config.py.

1095  def makeProcessModifier(self,func):
1096  """This is used to create a ProcessModifer which can perform actions on the process as a whole.
1097  This takes as argument a callable object (e.g. function) which takes as its sole argument an instance of Process.
1098  In order to work, the value returned from this function must be assigned to a uniquely named variable.
1099  """
return ProcessModifier(self,func)
def makeProcessModifier
Definition: Config.py:1094
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
which 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))

Definition at line 1100 of file Config.py.

References Config.Modifier.isChosen(), and groupFilesInBlocks.temp.

1101  def toModify(self,obj, func=None,**kw):
1102  """This is used to register an action to be performed on the specific object. Two different forms are allowed
1103  Form 1: A callable object (e.g. function) can be passed as the second. This callable object is expected to take one argument
1104  which will be the object passed in as the first argument.
1105  Form 2: A list of parameter name, value pairs can be passed
1106  mod.toModify(foo, fred=cms.int32(7), barney = cms.double(3.14))
1107  """
1108  if func is not None and len(kw) != 0:
1109  raise TypeError("toModify takes either two arguments or one argument and key/value pairs")
1110  if not self.isChosen():
1111  return
1112  if func is not None:
1113  func(obj)
1114  else:
1115  temp =_ParameterModifier(kw)
temp(obj)

Member Data Documentation

Config.Modifier.__chosen
private

Definition at line 1093 of file Config.py.

Referenced by Config.Modifier._setChosen(), Config.ModifierChain._setChosen(), Config.Modifier.isChosen(), and Config.ModifierChain.isChosen().

Config.Modifier.__processModifiers
private

Definition at line 1092 of file Config.py.