GaudiKernel.Configurable.SuperAlgorithm Class Reference

Inheritance diagram for GaudiKernel.Configurable.SuperAlgorithm:

Collaboration diagram for GaudiKernel.Configurable.SuperAlgorithm:

Public Member Functions
	__new__ (cls, name=None, **kwargs)
	__init__ (self, name=None, **kwargs)
	name (self)
	getType (cls)
	properties (self)
	isApplicable (self)
	getGaudiType (cls)
	__repr__ (self)
	__setattr__ (self, name, value)

Public Attributes
	graph = self._initGraph()

Protected Member Functions
	_makeAlg (self, typ, **kwargs)
	_initGraph (self)
	_visitSubNodes (self, visitor)

Protected Attributes
	_name = name or self.getType()

Detailed Description

Helper class to use a ControlFlowNode as an algorithm configurable
instance.

Definition at line 1842 of file Configurable.py.

Constructor & Destructor Documentation

__init__()

GaudiKernel.Configurable.SuperAlgorithm.__init__	(		self,
			name = None,
		**	kwargs )

Definition at line 1864 of file Configurable.py.

    def __init__(self, name=None, **kwargs):
        self._name = name or self.getType()
        self.graph = self._initGraph()
        for key in kwargs:
            setattr(self, key, kwargs[key])
 

Member Function Documentation

__new__()

GaudiKernel.Configurable.SuperAlgorithm.__new__	(		cls,
			name = None,
		**	kwargs )

Definition at line 1848 of file Configurable.py.

    def __new__(cls, name=None, **kwargs):
        if name is None:
            name = cls.__name__
        if name in Configurable.allConfigurables:
            instance = Configurable.allConfigurables[name]
            assert type(instance) is cls, (
                f"trying to reuse {name!r} as name of a {cls.__name__} instance while it"
                "s "
                f"already used for an instance of {type(instance).__name__}"
            )
            return instance
        else:
            instance = super().__new__(cls)
            Configurable.allConfigurables[name] = instance
            return instance
 

__repr__()

GaudiKernel.Configurable.SuperAlgorithm.__repr__

(

self

)

Definition at line 1902 of file Configurable.py.

    def __repr__(self):
        return f"{self.getType()}({self.name!r})"
 

__setattr__()

GaudiKernel.Configurable.SuperAlgorithm.__setattr__	(		self,
			name,
			value )

Definition at line 1909 of file Configurable.py.

    def __setattr__(self, name, value):
        super().__setattr__(name, value)
        if name in ("_name", "graph"):
            # do not propagate internal data members
            return
 
        class PropSetter:
            def enter(self, node):
                try:
                    setattr(node, name, value)
                except (ValueError, AttributeError):
                    # ignore type and name mismatch
                    pass
 
            def leave(self, node):
                pass
 
        self._visitSubNodes(PropSetter())

_initGraph()

GaudiKernel.Configurable.SuperAlgorithm._initGraph ( self )

protected

Reimplemented in Configuration.Gaudi_Test_MySuperAlg, and SuperAlgDynamicGraph.MySuperAlg.

Definition at line 1899 of file Configurable.py.

    def _initGraph(self):
        raise NotImplementedError()
 

_makeAlg()

GaudiKernel.Configurable.SuperAlgorithm._makeAlg ( self, typ, ** kwargs )

protected

Instantiate and algorithm of type 'typ' with a name suitable for use
inside a SuperAlgorithm.

Definition at line 1891 of file Configurable.py.

    def _makeAlg(self, typ, **kwargs):
        """
        Instantiate and algorithm of type 'typ' with a name suitable for use
        inside a SuperAlgorithm.
        """
        name = "{}_{}".format(self.name, kwargs.pop("name", typ.getType()))
        return typ(name, **kwargs)
 

_visitSubNodes()

GaudiKernel.Configurable.SuperAlgorithm._visitSubNodes ( self, visitor )

protected

Definition at line 1905 of file Configurable.py.

    def _visitSubNodes(self, visitor):
        if self.graph:
            self.graph.visitNode(visitor)
 

getGaudiType()

GaudiKernel.Configurable.SuperAlgorithm.getGaudiType

(

cls

)

Definition at line 1888 of file Configurable.py.

    def getGaudiType(cls):
        return "User"
 

getType()

GaudiKernel.Configurable.SuperAlgorithm.getType

(

cls

)

Definition at line 1875 of file Configurable.py.

    def getType(cls):
        return cls.__name__
 

isApplicable()

GaudiKernel.Configurable.SuperAlgorithm.isApplicable

(

self

)

Definition at line 1883 of file Configurable.py.

    def isApplicable(self):
        return False
 

name()

GaudiKernel.Configurable.SuperAlgorithm.name

(

self

)

Definition at line 1871 of file Configurable.py.

    def name(self):  # name is a read only property
        return self._name
 

properties()

GaudiKernel.Configurable.SuperAlgorithm.properties

(

self

)

Definition at line 1879 of file Configurable.py.

    def properties(self):
        pass
 

Member Data Documentation

_name

GaudiKernel.Configurable.SuperAlgorithm._name = name or self.getType()

protected

Definition at line 1865 of file Configurable.py.

graph

GaudiKernel.Configurable.SuperAlgorithm.graph = self._initGraph()

Definition at line 1866 of file Configurable.py.

---

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

• GaudiKernel/python/GaudiKernel/Configurable.py