Collaboration diagram for python.JetAnalysisCommon.Configured:

Public Member Functions
	__init__ (self, name, **props)
	__setattr__ (self, k, v)
	getName (self)
	setparent (self, parent)
	prefixed (self, k)
	ancestors (self)
	fullname (self)
	properties (self)
	typeAndName (self)
	asAnaAlg (self)
	toToolInAnaAlg (self, anaAlg, handlename)
	assignAllProperties (self, anaAlg)
	setPropToAnaAlg (self, k, v)
	getType (self)

Public Attributes
	type

Protected Member Functions
	_setattrImpl (self, k, v)

Protected Attributes
	_name = name
	_cppclass

Static Protected Attributes
	_properties = set()
dict	_propTypes = {}
	_parent = None
	_anaAlg = None
list	_allowed = ['_properties', '_name', '_parent', '_anaAlg']

Detailed Description

A replacement for Athena auto-generated Configured python class.
Configured has the same interface as its Athena counterpart and can describe both Tools and Algorithms

This is a base class. The system replacing CompFactory will generate a derived class for each c++ Tool/Algorithm
to hold the configuration of such tool/alg  (see generateConfigured())

Definition at line 88 of file JetAnalysisCommon.py.

Constructor & Destructor Documentation

◆ init()

python.JetAnalysisCommon.Configured.__init__	(		self,
			name,
		**	props )

Definition at line 104 of file JetAnalysisCommon.py.

    def __init__(self, name, **props):
        
        self._name = name
        self._properties = set()
        for k,v in props.items():             
            setattr(self,k,v)
 

Member Function Documentation

◆ setattr()

python.JetAnalysisCommon.Configured.__setattr__	(	self,
		k,
		v )

Definition at line 111 of file JetAnalysisCommon.py.

    def __setattr__(self, k, v):
        if k in self._allowed:
            self._setattrImpl(k,v)
        else:
            raise AttributeError("Configuration of Tool {} / {} . can't set attribute : {}".format(self.type, self._name, k) )
 

◆ _setattrImpl()

python.JetAnalysisCommon.Configured._setattrImpl	(	self,
		k,
		v )

protected

Definition at line 117 of file JetAnalysisCommon.py.

    def _setattrImpl(self, k, v) :
        super().__setattr__(k,v)
        if k[0] == '_' :
            # this is not a Property 
            return
 
        if isinstance(v, Configured):
            if k in self._properties:
                raise RuntimeError( "Configuring {} / {} : Tool for property {} already exists".format(self.type, self._name, k) )
            # it's a tool:
            v.setparent(self)
            v._name = k
        elif isinstance(v, (list, tuple) ):
            if isinstance(v[0], Configured):
                v = ConfArray(k,v, self)
                super().__setattr__(k,v)                
        self._properties.add(k)
        if self._anaAlg:
            self.setPropToAnaAlg( k , v)
 
 

◆ ancestors()

python.JetAnalysisCommon.Configured.ancestors ( self )

Definition at line 148 of file JetAnalysisCommon.py.

    def ancestors(self):
        if self._parent is None : return [self]
        return self._parent.ancestors()+[self]
    

◆ asAnaAlg()

python.JetAnalysisCommon.Configured.asAnaAlg ( self )

Returns this configured alg as an instance of Ana(Reentrant)AlgorithmConfig

Definition at line 163 of file JetAnalysisCommon.py.

    def asAnaAlg(self):
        """Returns this configured alg as an instance of Ana(Reentrant)AlgorithmConfig       
        """
        if issubclass(self._cppclass, ROOT.EL.AnaReentrantAlgorithm):
            alg=ROOT.EL.AnaReentrantAlgorithmConfig()
        else:
            alg=ROOT.EL.AnaAlgorithmConfig()
 
        alg.setTypeAndName( self.typeAndName() )
        self.assignAllProperties(alg)
        return alg
 
 

◆ assignAllProperties()

python.JetAnalysisCommon.Configured.assignAllProperties	(		self,
			anaAlg )

 Transfer all the configuration in self to anaAlg
where anaAlg is an AnaAlgorithmConfig.

Definition at line 189 of file JetAnalysisCommon.py.

    def assignAllProperties(self, anaAlg):
        """ Transfer all the configuration in self to anaAlg
        where anaAlg is an AnaAlgorithmConfig."""
        self._anaAlg = anaAlg 
        for (k,v) in self.properties():
            self.setPropToAnaAlg(k,v)
            

◆ fullname()

python.JetAnalysisCommon.Configured.fullname ( self )

Definition at line 152 of file JetAnalysisCommon.py.

    def fullname(self):
        parents = self.ancestors()[1:]
        return '.'.join([p._name for p in parents])
        

◆ getName()

python.JetAnalysisCommon.Configured.getName ( self )

Definition at line 138 of file JetAnalysisCommon.py.

    def getName(self):
        return self._name
    

◆ getType()

python.JetAnalysisCommon.Configured.getType ( self )

Definition at line 214 of file JetAnalysisCommon.py.

    def getType(self):
        return self.type
 

◆ prefixed()

python.JetAnalysisCommon.Configured.prefixed	(		self,
			k )

Definition at line 144 of file JetAnalysisCommon.py.

    def prefixed(self, k):
        if self._parent is None: return k
        return self.fullname()+'.'+k
 

◆ properties()

python.JetAnalysisCommon.Configured.properties ( self )

Definition at line 156 of file JetAnalysisCommon.py.

    def properties(self):
        return [ (k, getattr(self,k)) for k in self._properties]
 

◆ setparent()

python.JetAnalysisCommon.Configured.setparent	(		self,
			parent )

Definition at line 141 of file JetAnalysisCommon.py.

    def setparent(self, parent):
        self._parent = parent
 

◆ setPropToAnaAlg()

python.JetAnalysisCommon.Configured.setPropToAnaAlg	(	self,
		k,
		v )

Definition at line 196 of file JetAnalysisCommon.py.

    def setPropToAnaAlg(self, k, v):
        alg=self._anaAlg
        if isinstance(v , Configured):
            # it must be a Tool :
            try:
                alg.addPrivateTool(v.fullname(), v.type)
            except RuntimeError:
                # this means the tool is already declared, nothing to do.
                pass #
            v.assignAllProperties(alg)
        elif isinstance(v, ConfArray ):
            # it is a Tool array 
            v.assignAllProperties(alg)
        else:
            # any other type :
            cpptype = self._propTypes[k]
            alg.setProperty[cpptype](self.prefixed(k) , v)
 

◆ toToolInAnaAlg()

python.JetAnalysisCommon.Configured.toToolInAnaAlg	(	self,
		anaAlg,
		handlename )

If self represents a configured AlgTool,
this call will configure the AnaAlgorithmConfig 'anaAlg' so
its ToolHandle property 'handlename' is configured with self

Definition at line 176 of file JetAnalysisCommon.py.

    def toToolInAnaAlg(self, anaAlg, handlename):
        """If self represents a configured AlgTool,
        this call will configure the AnaAlgorithmConfig 'anaAlg' so
        its ToolHandle property 'handlename' is configured with self
        """
        if handlename in anaAlg._props:
            return
        props = {handlename:self,  }
        klass=type('TmpConf', (Configured,), dict(_allowed=self._allowed+[handlename], _propTypes={},
                                                              type=anaAlg.getType(),_cppclass='none') )
        c=klass(anaAlg.name(), **props)
        c.assignAllProperties(anaAlg)
        

◆ typeAndName()

python.JetAnalysisCommon.Configured.typeAndName ( self )

Definition at line 159 of file JetAnalysisCommon.py.

    def typeAndName(self):
        return self.type+'/'+self._name

Member Data Documentation

◆ _allowed

list python.JetAnalysisCommon.Configured._allowed = ['_properties', '_name', '_parent', '_anaAlg']

staticprotected

Definition at line 102 of file JetAnalysisCommon.py.

◆ _anaAlg

python.JetAnalysisCommon.Configured._anaAlg = None

staticprotected

Definition at line 99 of file JetAnalysisCommon.py.

◆ _cppclass

python.JetAnalysisCommon.Configured._cppclass

protected

Definition at line 166 of file JetAnalysisCommon.py.

◆ _name

python.JetAnalysisCommon.Configured._name = name

protected

Definition at line 106 of file JetAnalysisCommon.py.

◆ _parent

python.JetAnalysisCommon.Configured._parent = None

staticprotected

Definition at line 98 of file JetAnalysisCommon.py.

◆ _properties

python.JetAnalysisCommon.Configured._properties = set()

staticprotected

Definition at line 96 of file JetAnalysisCommon.py.

◆ _propTypes

dict python.JetAnalysisCommon.Configured._propTypes = {}

staticprotected

Definition at line 97 of file JetAnalysisCommon.py.

◆ type

python.JetAnalysisCommon.Configured.type

Definition at line 115 of file JetAnalysisCommon.py.

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

JetAnalysisCommon.py

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __setattr__()

◆ _setattrImpl()

◆ ancestors()

◆ asAnaAlg()

◆ assignAllProperties()

◆ fullname()

◆ getName()

◆ getType()

◆ prefixed()

◆ properties()

◆ setparent()

◆ setPropToAnaAlg()

◆ toToolInAnaAlg()

◆ typeAndName()

Member Data Documentation

◆ _allowed

◆ _anaAlg

◆ _cppclass

◆ _name

◆ _parent

◆ _properties

◆ _propTypes

◆ type

◆ init()

◆ setattr()