Inheritance diagram for python.JetDefinition.JetModifier:

Collaboration diagram for python.JetDefinition.JetModifier:

Public Member Functions
	__init__ (self, tooltype, toolname, createfn=None, filterfn=_condAlwaysPass, prereqs=[], modspec=None, **properties)
	tooltype (self)
	toolname (self)
	createfn (self)
	modspec (self)
	prereqs (self)
	filterfn (self)
	properties (self)
	__hash__ (self)
	__eq__ (self, rhs)
	__ne__ (self, rhs)
	__str__ (self)
	getGenericModifier (self, jetdef, modspec)

Public Attributes
	tooltype = tooltype
	toolname = toolname
	createfn = self.getGenericModifier
	modspec = modspec
	prereqs = prereqs
	filterfn = filterfn
	properties = properties

Static Private Attributes
	__repr__ = __str__

Detailed Description

Helper to define the config of a IJetModifier tool.
Tools that typically have more complex properties set should have
their own dedicated helper 'createfn' functions defined

Definition at line 253 of file JetDefinition.py.

Constructor & Destructor Documentation

◆ init()

python.JetDefinition.JetModifier.__init__	(		self,
			tooltype,
			toolname,
			createfn = None,
			filterfn = _condAlwaysPass,
			prereqs = [],
			modspec = None,
		**	properties )

Definition at line 258 of file JetDefinition.py.

                 ):
        # For the easy cases where no helper function is needed.
        # They will be ignored in the case of a helper,
        # but are still required such that it's obvious what
        # the tool name and type are when defining the config.
        self.tooltype = tooltype
        self.toolname = toolname
 
        # The helper function may take 2 parameters:
        # a "modifier specification" string and the jet
        # definition
 
        # The helper function always returns the desired
        # modifier, and a ComponentAccumulator instance, 
        # in case additional supporting tools/services
        # need to be set up.
        if createfn is None:
            self.createfn = self.getGenericModifier
        else:
            self.createfn = createfn
        self.modspec = modspec
 
        # Prereqs is normally a list.
        # However, in special cases, the prereqs may
        # depend on either or both of modspec and jetdef,
        # in which case a helper function can be defined.
        self.prereqs = prereqs
 
        # a function taking a CondFlags as argument and deciding if this JetModifier is compatible
        # with the conditions.
        #  The function must return a tuple : (bool, "reason of failure")
        self.filterfn = filterfn 
 
        # These will be set as the Gaudi properties of the C++ tool
        self.properties = properties
        
                
 
        

Member Function Documentation

◆ eq()

python.JetDefinition.JetModifier.__eq__	(		self,
			rhs )

Definition at line 322 of file JetDefinition.py.

    def __eq__(self,rhs):
        return self.__hash__() == rhs.__hash__()
 

◆ hash()

python.JetDefinition.JetModifier.__hash__ ( self )

Definition at line 319 of file JetDefinition.py.

    def __hash__(self):
        return hash((self.toolname,self.tooltype,self.createfn.__name__,self.modspec,str(self.prereqs)))
 

◆ ne()

python.JetDefinition.JetModifier.__ne__	(		self,
			rhs )

Definition at line 325 of file JetDefinition.py.

    def __ne__(self,rhs):
        return (not self.__eq__(rhs))
 

◆ str()

python.JetDefinition.JetModifier.__str__ ( self )

Definition at line 329 of file JetDefinition.py.

329 def __str__(self):

330 return "JetModifier({0}/{1})".format(self.tooltype,self.toolname)

◆ createfn()

python.JetDefinition.JetModifier.createfn ( self )

Definition at line 307 of file JetDefinition.py.

307 def createfn(self):pass

◆ filterfn()

python.JetDefinition.JetModifier.filterfn ( self )

Definition at line 313 of file JetDefinition.py.

313 def filterfn(self):pass

◆ getGenericModifier()

python.JetDefinition.JetModifier.getGenericModifier	(	self,
		jetdef,
		modspec )

returns a real tool instance accoding to this definition : simply instantiating from
class self.tooltype and with name self.toolname ( actually : self.toolname.format(modspec) )
Since this function will be called as a callback from JetRecConfig as 'func(jetdef, modspec)', it must accept
the jetdef argument, even if unused in this case.

Definition at line 334 of file JetDefinition.py.

    def getGenericModifier(self,jetdef, modspec):
        """returns a real tool instance accoding to this definition : simply instantiating from
        class self.tooltype and with name self.toolname ( actually : self.toolname.format(modspec) )
        Since this function will be called as a callback from JetRecConfig as 'func(jetdef, modspec)', it must accept
        the jetdef argument, even if unused in this case.
        """
        from AthenaConfiguration.ComponentFactory import CompFactory
        name = self.toolname.format(modspec=modspec)
        tool = CompFactory.getComp(self.tooltype)(name)
        return tool
 
 
 
 

◆ modspec()

python.JetDefinition.JetModifier.modspec ( self )

Definition at line 309 of file JetDefinition.py.

309 def modspec(self):pass

◆ prereqs()

python.JetDefinition.JetModifier.prereqs ( self )

Definition at line 311 of file JetDefinition.py.

311 def prereqs(self):pass

◆ properties()

python.JetDefinition.JetModifier.properties ( self )

Definition at line 315 of file JetDefinition.py.

    def properties(self):pass

◆ toolname()

python.JetDefinition.JetModifier.toolname ( self )

Definition at line 305 of file JetDefinition.py.

305 def toolname(self):pass

◆ tooltype()

python.JetDefinition.JetModifier.tooltype ( self )

Definition at line 303 of file JetDefinition.py.

303 def tooltype(self):pass

Member Data Documentation

◆ repr

python.JetDefinition.JetModifier.__repr__ = __str__

staticprivate

Definition at line 332 of file JetDefinition.py.

◆ createfn

python.JetDefinition.JetModifier.createfn = self.getGenericModifier

Definition at line 280 of file JetDefinition.py.

◆ filterfn

python.JetDefinition.JetModifier.filterfn = filterfn

Definition at line 294 of file JetDefinition.py.

◆ modspec

python.JetDefinition.JetModifier.modspec = modspec

Definition at line 283 of file JetDefinition.py.

◆ prereqs

python.JetDefinition.JetModifier.prereqs = prereqs

Definition at line 289 of file JetDefinition.py.

◆ properties

python.JetDefinition.JetModifier.properties = properties

Definition at line 297 of file JetDefinition.py.

◆ toolname

python.JetDefinition.JetModifier.toolname = toolname

Definition at line 269 of file JetDefinition.py.

◆ tooltype

python.JetDefinition.JetModifier.tooltype = tooltype

Definition at line 268 of file JetDefinition.py.

The documentation for this class was generated from the following file:

JetDefinition.py

Public Member Functions

Public Attributes

Static Private Attributes