python.JetDefinition.JetModifier Class Reference

Inheritance diagram for python.JetDefinition.JetModifier:

Collaboration diagram for python.JetDefinition.JetModifier:

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

Public Attributes
	tooltype
	toolname
	createfn
	modspec
	prereqs
	filterfn
	properties

Static Private Attributes
def	__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 248 of file JetDefinition.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 253 of file JetDefinition.py.

    def __init__(self,tooltype,toolname,
                 createfn=None,
                 filterfn=_condAlwaysPass,                 
                 prereqs=[],modspec=None,
                 **properties
                 ):
        # 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__()

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

Definition at line 317 of file JetDefinition.py.

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

__hash__()

def python.JetDefinition.JetModifier.__hash__

(

self

)

Definition at line 314 of file JetDefinition.py.

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

__ne__()

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

Definition at line 320 of file JetDefinition.py.

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

__str__()

def python.JetDefinition.JetModifier.__str__

(

self

)

Definition at line 324 of file JetDefinition.py.

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

createfn()

def python.JetDefinition.JetModifier.createfn

(

self

)

Definition at line 302 of file JetDefinition.py.

    def createfn(self):pass

filterfn()

def python.JetDefinition.JetModifier.filterfn

(

self

)

Definition at line 308 of file JetDefinition.py.

    def filterfn(self):pass

getGenericModifier()

def 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 329 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()

def python.JetDefinition.JetModifier.modspec

(

self

)

Definition at line 304 of file JetDefinition.py.

    def modspec(self):pass

prereqs()

def python.JetDefinition.JetModifier.prereqs

(

self

)

Definition at line 306 of file JetDefinition.py.

    def prereqs(self):pass

properties()

def python.JetDefinition.JetModifier.properties

(

self

)

Definition at line 310 of file JetDefinition.py.

    def properties(self):pass
 
    
    

toolname()

def python.JetDefinition.JetModifier.toolname

(

self

)

Definition at line 300 of file JetDefinition.py.

    def toolname(self):pass

tooltype()

def python.JetDefinition.JetModifier.tooltype

(

self

)

Definition at line 298 of file JetDefinition.py.

    def tooltype(self):pass

Member Data Documentation

__repr__

def python.JetDefinition.JetModifier.__repr__ = __str__

staticprivate

Definition at line 327 of file JetDefinition.py.

createfn

python.JetDefinition.JetModifier.createfn

Definition at line 270 of file JetDefinition.py.

filterfn

python.JetDefinition.JetModifier.filterfn

Definition at line 284 of file JetDefinition.py.

modspec

python.JetDefinition.JetModifier.modspec

Definition at line 273 of file JetDefinition.py.

prereqs

python.JetDefinition.JetModifier.prereqs

Definition at line 279 of file JetDefinition.py.

properties

python.JetDefinition.JetModifier.properties

Definition at line 287 of file JetDefinition.py.

toolname

python.JetDefinition.JetModifier.toolname

Definition at line 259 of file JetDefinition.py.

tooltype

python.JetDefinition.JetModifier.tooltype

Definition at line 258 of file JetDefinition.py.

---

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

• JetDefinition.py