python.Configurables.CfgPyAlgorithm Class Reference

Configurable base class for PyAlgorithms -------------------------------—. More...

Inheritance diagram for python.Configurables.CfgPyAlgorithm:

Collaboration diagram for python.Configurables.CfgPyAlgorithm:

Public Member Functions
def	__init__ (self, name, **kw)
def	getGaudiType (self)
def	getType (self)
def	setup (self)
def	getDlls (self)
def	msg (self)
def	getHandle (self)
def	__getstate__ (self)
def	__setstate__ (self, state)
def	merge (self, other)

Public Attributes
	OutputLevel
	special case of the OutputLevel: take the value from the svcMgr.MessageSvc if none already set by user More...

Detailed Description

Configurable base class for PyAlgorithms -------------------------------—.

Definition at line 130 of file Configurables.py.

Constructor & Destructor Documentation

__init__()

def python.Configurables.CfgPyAlgorithm.__init__	(		self,
			name,
		**	kw
	)

Reimplemented from python.Configurables.CfgPyComponent.

Definition at line 131 of file Configurables.py.

    def __init__( self, name, **kw ):
        if isinstance(self, LegacyConfigurable):
            _alg_base.__init__(self, name)
        else:
            _alg_base.__init__(self, name, **kw)
        CfgPyComponent.__init__(self, name, **kw)
 

Member Function Documentation

__getstate__()

def python.Configurables.CfgPyComponent.__getstate__ (   self )

inherited

Definition at line 63 of file Configurables.py.

    def __getstate__(self):
        state = super().__getstate__()
        state.update(self.__dict__)
        return state
 

__setstate__()

def python.Configurables.CfgPyComponent.__setstate__ (   self,   state  )

inherited

Definition at line 68 of file Configurables.py.

    def __setstate__(self, state):
        self.__dict__.update(state)
        super().__setstate__(state)
 

getDlls()

def python.Configurables.CfgPyComponent.getDlls (   self )

inherited

Definition at line 52 of file Configurables.py.

    def getDlls(self):
        return 'AthenaPython'
 

getGaudiType()

def python.Configurables.CfgPyAlgorithm.getGaudiType

(

self

)

Definition at line 138 of file Configurables.py.

    def getGaudiType( self ): return 'Algorithm'

getHandle()

def python.Configurables.CfgPyComponent.getHandle (   self )

inherited

Definition at line 60 of file Configurables.py.

    def getHandle(self):
        return None
 

getType()

def python.Configurables.CfgPyAlgorithm.getType

(

self

)

Definition at line 139 of file Configurables.py.

    def getType(self):        return 'PyAthena::Alg'
 

merge()

def python.Configurables.CfgPyComponent.merge (   self,   other  )

inherited

Basic merge for Python components.
Checks that all attributes/properties are identical.

Definition at line 91 of file Configurables.py.

    def merge(self, other):
        """Basic merge for Python components.
        Checks that all attributes/properties are identical.
        """
        if self is other:
            return self
 
        if type(self) is not type(other):
            raise TypeError(f"cannot merge instance of {type(other).__name__} into "
                            f"an instance of { type(self).__name__}")
 
        if self.name != other.name:
            raise ValueError(f"cannot merge configurables with different names ({self.name} and {other.name})")
 
        for prop in other.__dict__:
            if (hasattr(self, prop) and getattr(self, prop) == getattr(other, prop)):
                continue
            else:
                raise ValueError(f"conflicting settings for property {prop} of {self.name}: "
                                 f"{getattr(self,prop)} vs {getattr(other,prop)}")
        return self
 
 

msg()

def python.Configurables.CfgPyComponent.msg (   self )

inherited

Definition at line 56 of file Configurables.py.

    def msg(self):
        import AthenaCommon.Logging as _L
        return _L.logging.getLogger( self.getName() )
 

setup()

def python.Configurables.CfgPyAlgorithm.setup

(

self

)

Reimplemented from python.Configurables.CfgPyComponent.

Definition at line 141 of file Configurables.py.

    def setup(self):
        
        from AthenaPython import PyAthena
        setattr(PyAthena.algs, self.getName(), self)
 
        
        CfgPyComponent.setup(self)
        if isinstance(self, LegacyConfigurable):
            ConfigurableAlgorithm.setup(self)
 
 

Member Data Documentation

OutputLevel

python.Configurables.CfgPyComponent.OutputLevel

inherited

special case of the OutputLevel: take the value from the svcMgr.MessageSvc if none already set by user

Definition at line 81 of file Configurables.py.

---

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

• Configurables.py