Inheritance diagram for ConfigToolBase.ConfigToolBase:

Public Member Functions
def	__call__ (self, process)

def	__copy__ (self)
	copy(self) returns a copy of the tool More...

def	__init__ (self)

def	addParameter (self, dict, parname, parvalue, description, Type=None, allowedValues=None, acceptNoneValue=False)
	use addParameter method in the redefinition of tool constructor in order to add parameters to the tools each tool is defined by its label, default value, description, type and allowedValues (the last two attribute can be ignored if the user gives a valid default values and if there is not a list of allowed values) More...

def	apply (self, process)

def	comment (self)

def	description (self)

def	dumpPython (self)

def	errorMessage (self, value, type)

def	getAllowedValues (self, name)

def	getParameters (self)

def	getvalue (self, name)

def	isAllowed (self, name, value)
	method isAllowed is called by setParameter to check input values for a specific parameter More...

def	reset (self)

def	setComment (self, comment)

def	setParameter (self, name, value, typeNone=False)

def	setParameters (self, parameters)

def	toolCode (self, process)

def	typeError (self, name)
	check about input value type More...

Public Attributes
	parAccepted

Private Attributes
	_comment

	_description

	_parameters

	_path

Detailed Description

Base class for PAT tools

Definition at line 33 of file ConfigToolBase.py.

Constructor & Destructor Documentation

def ConfigToolBase.ConfigToolBase.__init__ ( self )

Definition at line 40 of file ConfigToolBase.py.

     def __init__(self):
         self._parameters=dicttypes.SortedKeysDict()
         self._description=self.__doc__
         self._comment = ''
         self.parAccepted=True
         saveOrigin(self,1)
         self._path = path.realpath(self._filename)        
         self._path = self._path.split("/src/")
         self._path = self._path[1].replace("/python","")
         #self._path = "".join(self._path)
         self._path = self._path.replace("/",".")
         self._path = self._path.replace(".py","")
 
 

Member Function Documentation

def ConfigToolBase.ConfigToolBase.__call__	(	self,
		process
	)

Call the instance

Definition at line 54 of file ConfigToolBase.py.

     def __call__(self,process):
         """ Call the instance 
         """
         raise NotImplementedError
 

def ConfigToolBase.ConfigToolBase.__copy__ ( self )

copy(self) returns a copy of the tool

Definition at line 83 of file ConfigToolBase.py.

References ConfigToolBase.ConfigToolBase._comment, and ConfigToolBase.ConfigToolBase._parameters.

Referenced by ConfigToolBase.ConfigToolBase.apply().

     def __copy__(self):
         c=type(self)()
         c.setParameters(copy.deepcopy(self._parameters))
         c.setComment(self._comment)
         return c

def ConfigToolBase.ConfigToolBase.addParameter	(	self,
		dict,
		parname,
		parvalue,
		description,
		Type = `None`,
		allowedValues = `None`,
		acceptNoneValue = `False`
	)

use addParameter method in the redefinition of tool constructor in order to add parameters to the tools each tool is defined by its label, default value, description, type and allowedValues (the last two attribute can be ignored if the user gives a valid default values and if there is not a list of allowed values)

Add a parameter with its label, value, description and type to self._parameters

Definition at line 102 of file ConfigToolBase.py.

Referenced by editorTools.UserCodeTool.__init__(), metTools.AddMETCollection.__init__(), trackTools.MakeAODTrackCandidates.__init__(), coreTools.RunOnData.__init__(), HiCoreTools.RestrictInputToAOD.__init__(), runJetUncertainties.RunJetUncertainties.__init__(), runMETCorrectionsAndUncertainties.RunMETCorrectionsAndUncertainties.__init__(), Vispa.Plugins.ConfigEditor.ToolDataAccessor.ImportTool.__init__(), editorTools.ChangeSource.__init__(), cmsswVersionTools.PickRelValInputFiles.__init__(), HiCoreTools.RemoveMCMatching.__init__(), coreTools.RemoveMCMatching.__init__(), trackTools.MakePATTrackCandidates.__init__(), trigTools.SwitchOnTrigger.__init__(), HiCoreTools.RemoveAllPATObjectsBut.__init__(), HiCoreTools.RemoveSpecificPATObjects.__init__(), trigTools.SwitchOnTriggerStandAlone.__init__(), trackTools.MakeTrackCandidates.__init__(), tauTools.AddTauCollection.__init__(), trigTools.SwitchOnTriggerMatching.__init__(), HiCoreTools.RemoveCleaning.__init__(), HiCoreTools.AddCleaning.__init__(), trigTools.SwitchOnTriggerMatchingStandAlone.__init__(), trigTools.SwitchOnTriggerMatchEmbedding.__init__(), jetTools.AddJetCollection.__init__(), jetTools.SwitchJetCollection.__init__(), jetTools.UpdateJetCollection.__init__(), jetTools.AddJetID.__init__(), and jetTools.SetTagInfos.__init__().

     def addParameter(self,dict,parname, parvalue, description,Type=None, allowedValues=None, acceptNoneValue=False):
         """ Add a parameter with its label, value, description and type to self._parameters
         """
         par=parameter()
         par.name=parname
         par.value=parvalue
         par.description=description
         if Type==None:
             par.type=type(parvalue)
         else: par.type=Type
         par.allowedValues=allowedValues
         par.acceptNoneValue=acceptNoneValue
         dict[par.name]=par        

def ConfigToolBase.ConfigToolBase.apply	(	self,
		process
	)

Definition at line 59 of file ConfigToolBase.py.

References ConfigToolBase.ConfigToolBase.__copy__(), pos::PixelConfigBase.setComment(), L1TUtmTriggerMenu.setComment(), ConfigToolBase.ConfigToolBase.setComment(), Json::Value.setComment(), Json::Value::CommentInfo.setComment(), and ConfigToolBase.ConfigToolBase.toolCode().

Referenced by heavyIonTools.ConfigureHeavyIons.__call__(), editorTools.UserCodeTool.__call__(), HiCoreTools.RestrictInputToAOD.__call__(), coreTools.RunOnData.__call__(), trackTools.MakeAODTrackCandidates.__call__(), runJetUncertainties.RunJetUncertainties.__call__(), metTools.AddMETCollection.__call__(), heavyIonTools.ProductionDefaults.__call__(), editorTools.ChangeSource.__call__(), HiCoreTools.RemoveMCMatching.__call__(), cmsswVersionTools.PickRelValInputFiles.__call__(), coreTools.RemoveMCMatching.__call__(), trackTools.MakePATTrackCandidates.__call__(), trigTools.SwitchOnTrigger.__call__(), runMETCorrectionsAndUncertainties.RunMETCorrectionsAndUncertainties.__call__(), heavyIonTools.SelectionDefaults.__call__(), HiCoreTools.RemoveAllPATObjectsBut.__call__(), heavyIonTools.DisbaleMonteCarloDeps.__call__(), HiCoreTools.RemoveSpecificPATObjects.__call__(), trigTools.SwitchOnTriggerStandAlone.__call__(), trackTools.MakeTrackCandidates.__call__(), tauTools.AddTauCollection.__call__(), trigTools.SwitchOnTriggerMatching.__call__(), HiCoreTools.RemoveCleaning.__call__(), HiCoreTools.AddCleaning.__call__(), trigTools.SwitchOnTriggerMatchingStandAlone.__call__(), trigTools.SwitchOnTriggerMatchEmbedding.__call__(), jetTools.AddJetCollection.__call__(), jetTools.SwitchJetCollection.__call__(), jetTools.UpdateJetCollection.__call__(), jetTools.AddJetID.__call__(), and jetTools.SetTagInfos.__call__().

     def apply(self,process):
 
         if hasattr(process, "addAction"):
             process.disableRecording()
 
         try:
             comment=inspect.stack(2)[2][4][0].rstrip("\n")
             if comment.startswith("#"):
                 self.setComment(comment.lstrip("#"))
         except:
             pass
 
         self.toolCode(process)
 
         if hasattr(process, "addAction"):
             process.enableRecording()
             action=self.__copy__()
             process.addAction(action)
 

def ConfigToolBase.ConfigToolBase.comment ( self )

Return the comment set for this tool

Definition at line 157 of file ConfigToolBase.py.

References ConfigToolBase.ConfigToolBase._comment.

     def comment(self):
         """ Return the comment set for this tool
         """
         return self._comment

def ConfigToolBase.ConfigToolBase.description ( self )

Return a string with a detailed description of the action.

Definition at line 94 of file ConfigToolBase.py.

References ConfigToolBase.ConfigToolBase._description.

     def description(self):
         """ Return a string with a detailed description of the action.
         """
         return self._description
 

def ConfigToolBase.ConfigToolBase.dumpPython ( self )

Return the python code to perform the action

Definition at line 134 of file ConfigToolBase.py.

Referenced by Mixins._Parameterizable.__addParameter(), Mixins._ParameterTypeBase.__repr__(), Mixins._Parameterizable.__repr__(), Mixins._ValidatingParameterListBase.__repr__(), Types.VPSet.__repr__(), Mixins._Parameterizable.__setattr__(), and SequenceTypes.Schedule.__str__().

     def dumpPython(self):
         """ Return the python code to perform the action
         """ 
         dumpPythonImport = "\nfrom "+self._path+" import *\n"
         dumpPython=''
         if self._comment!="":
             dumpPython = '#'+self._comment
         dumpPython += "\n"+self._label+"(process "
         for key in self._parameters.keys():
             if repr(self._parameters[key].value)!=repr(self._defaultParameters[key].value):
                 dumpPython+= ", "+str(key)+" = "
                 if self._parameters[key].type is str:
                     string = "'"+str(self.getvalue(key))+"'"
                 else:
                     string = str(self.getvalue(key))
                 dumpPython+= string
         dumpPython+=")"+'\n'
         return (dumpPythonImport,dumpPython)
 

def ConfigToolBase.ConfigToolBase.errorMessage	(	self,
		value,
		type
	)

Definition at line 161 of file ConfigToolBase.py.

References str.

Referenced by Vispa.Main.Application.Application._loadPlugins(), Vispa.Main.Application.Application.openFile(), and ConfigToolBase.ConfigToolBase.typeError().

161 def errorMessage(self,value,type):

162 return "The type for parameter "+'"'+str(value)+'"'+" is not "+'"'+str(type)+'"'

ConfigToolBase.ConfigToolBase.errorMessage

def errorMessage(self, value, type)

Definition: ConfigToolBase.py:161

str

#define str(s)

Definition: TestProcessor.cc:47

def ConfigToolBase.ConfigToolBase.getAllowedValues	(	self,
		name
	)

Definition at line 192 of file ConfigToolBase.py.

     def getAllowedValues(self,name):
         return self._defaultParameters[name].allowedValues

def ConfigToolBase.ConfigToolBase.getParameters ( self )

Return a copy of the dict of the parameters.

Definition at line 115 of file ConfigToolBase.py.

References ConfigToolBase.ConfigToolBase._parameters.

     def getParameters(self):
         """ Return a copy of the dict of the parameters.
         """
         return copy.deepcopy(self._parameters)

def ConfigToolBase.ConfigToolBase.getvalue	(	self,
		name
	)

Return the value of parameter 'name'

Definition at line 90 of file ConfigToolBase.py.

References ConfigToolBase.ConfigToolBase._parameters.

Referenced by ConfigToolBase.ConfigToolBase.dumpPython().

     def getvalue(self,name):
         """ Return the value of parameter 'name'
         """
         return self._parameters[name].value

def ConfigToolBase.ConfigToolBase.isAllowed	(	self,
		name,
		value
	)

method isAllowed is called by setParameter to check input values for a specific parameter

Definition at line 164 of file ConfigToolBase.py.

References ConfigToolBase.ConfigToolBase._parameters, ConfigToolBase.ConfigToolBase.parAccepted, and str.

Referenced by ConfigToolBase.ConfigToolBase.setParameter().

     def isAllowed(self,name,value):
         self.parAccepted=True
         if value==[]:
             self.parAccepted=False
         elif (isinstance(value,dict)) and (isinstance(self._parameters[name].allowedValues,list)):
             for key in value.keys():
                 if (key not in self._parameters[name].allowedValues):
                     raise ValueError("The input key value "+'"'+str(key)+'"'+" for parameter "+'"'+name+'"'+" is not supported. Supported ones are: "+str(self._parameters[name].allowedValues)[1:-1])
         elif (isinstance(value,list)) and (isinstance(self._parameters[name].allowedValues,list )):
             for val in value:
                 if (val not in self._parameters[name].allowedValues) :
                     raise ValueError("The input value "+'"'+str(val)+'"'+" for parameter "+'"'+name+'"'+" is not supported. Supported ones are: "+str(self._parameters[name].allowedValues)[1:-1])
         elif (not isinstance(value,list))and (isinstance(self._parameters[name].allowedValues,list)) :
             if (value not in self._parameters[name].allowedValues and value == None) and (not self._parameters[name].acceptNoneValue) :
                 self.parAccepted=False
         elif not isinstance(self._parameters[name].allowedValues,list):
             if (value!=self._parameters[name].allowedValues and value == None) and (not self._parameters[name].acceptNoneValue) :
                 self.parAccepted=False  
         if self.parAccepted==False:
             raise ValueError("The input value "+'"'+str(value)+'"'+" for parameter "+'"'+name+'"'+" is not supported. Supported ones are: "+str(self._parameters[name].allowedValues)[1:-1])

def ConfigToolBase.ConfigToolBase.reset ( self )

Definition at line 88 of file ConfigToolBase.py.

88 def reset(self):

89 self._parameters=copy.deepcopy(self._defaultParameters)

ConfigToolBase.ConfigToolBase._parameters

_parameters

Definition: ConfigToolBase.py:41

ConfigToolBase.ConfigToolBase.reset

def reset(self)

Definition: ConfigToolBase.py:88

def ConfigToolBase.ConfigToolBase.setComment	(	self,
		comment
	)

Write a comment in the configuration file

Definition at line 153 of file ConfigToolBase.py.

References ConfigToolBase.ConfigToolBase._comment, and str.

Referenced by ConfigToolBase.ConfigToolBase.apply().

     def setComment(self, comment):
         """ Write a comment in the configuration file
         """
         self._comment = str(comment)

def ConfigToolBase.ConfigToolBase.setParameter	(	self,
		name,
		value,
		typeNone = `False`
	)

Change parameter 'name' to a new value

Definition at line 119 of file ConfigToolBase.py.

Referenced by editorTools.UserCodeTool.__call__(), HiCoreTools.RestrictInputToAOD.__call__(), coreTools.RunOnData.__call__(), trackTools.MakeAODTrackCandidates.__call__(), runJetUncertainties.RunJetUncertainties.__call__(), metTools.AddMETCollection.__call__(), editorTools.ChangeSource.__call__(), HiCoreTools.RemoveMCMatching.__call__(), cmsswVersionTools.PickRelValInputFiles.__call__(), coreTools.RemoveMCMatching.__call__(), trackTools.MakePATTrackCandidates.__call__(), trigTools.SwitchOnTrigger.__call__(), runMETCorrectionsAndUncertainties.RunMETCorrectionsAndUncertainties.__call__(), HiCoreTools.RemoveAllPATObjectsBut.__call__(), HiCoreTools.RemoveSpecificPATObjects.__call__(), trigTools.SwitchOnTriggerStandAlone.__call__(), trackTools.MakeTrackCandidates.__call__(), tauTools.AddTauCollection.__call__(), trigTools.SwitchOnTriggerMatching.__call__(), HiCoreTools.RemoveCleaning.__call__(), HiCoreTools.AddCleaning.__call__(), trigTools.SwitchOnTriggerMatchingStandAlone.__call__(), trigTools.SwitchOnTriggerMatchEmbedding.__call__(), jetTools.AddJetCollection.__call__(), jetTools.SwitchJetCollection.__call__(), jetTools.UpdateJetCollection.__call__(), jetTools.AddJetID.__call__(), jetTools.SetTagInfos.__call__(), and runMETCorrectionsAndUncertainties.RunMETCorrectionsAndUncertainties.jetConfiguration().

     def setParameter(self, name, value, typeNone=False):
         """ Change parameter 'name' to a new value
         """
         self._parameters[name].value=value
         ### check about input value type 
         self.typeError(name)
         ### check about input value (it works if allowedValues for the specific parameter is set)
         if self._defaultParameters[name].allowedValues is not None: self.isAllowed(name,value )

def ConfigToolBase.ConfigToolBase.setParameters	(	self,
		parameters
	)

Definition at line 127 of file ConfigToolBase.py.

References ConfigToolBase.ConfigToolBase._parameters.

127 def setParameters(self, parameters):

128 self._parameters=copy.deepcopy(parameters)

ConfigToolBase.ConfigToolBase.setParameters

def setParameters(self, parameters)

Definition: ConfigToolBase.py:127

ConfigToolBase.ConfigToolBase._parameters

_parameters

Definition: ConfigToolBase.py:41

def ConfigToolBase.ConfigToolBase.toolCode	(	self,
		process
	)

Definition at line 78 of file ConfigToolBase.py.

Referenced by ConfigToolBase.ConfigToolBase.apply().

     def toolCode(self, process):
         raise NotImplementedError

def ConfigToolBase.ConfigToolBase.typeError	(	self,
		name
	)

check about input value type

Definition at line 185 of file ConfigToolBase.py.

References ConfigToolBase.ConfigToolBase._parameters, CTPPSPixelDataError.errorMessage(), FWEventItem.errorMessage(), and ConfigToolBase.ConfigToolBase.errorMessage().

Referenced by ConfigToolBase.ConfigToolBase.setParameter().

     def typeError(self,name):
         if self._parameters[name].acceptNoneValue is False:
             if not isinstance(self._parameters[name].value,self._parameters[name].type):
                 raise TypeError(self.errorMessage(self._parameters[name].value,self._parameters[name].type))
         else:
             if not (isinstance(self._parameters[name].value,self._parameters[name].type) or self._parameters[name].value is  None):
                 raise TypeError(self.errorMessage(self._parameters[name].value,self._parameters[name].type))