Inheritance diagram for GaudiKernel.Configurable.ConfigurableAlgTool:

Collaboration diagram for GaudiKernel.Configurable.ConfigurableAlgTool:

Public Member Functions
	__init__ (self, name=Configurable.DefaultName)
	getHandle (self)
	getGaudiType (cls)
	getGaudiHandle (self)
	getPrintTitle (self)
	setParent (self, parentName)
	getParent (self)
	hasParent (self, parent)
	getJobOptName (self)
	isPublic (self)
	isInToolSvc (self)
	toStringProperty (self)
	getFullName (self)
Public Member Functions inherited from GaudiKernel.Configurable.Configurable
	__new__ (cls, args, *kwargs)
	__init__ (self, name=DefaultName)
	__getstate__ (self)
	__getnewargs__ (self)
	__setstate__ (self, dict)
	__len__ (self)
	__iter__ (self)
	__deepcopy__ (self, memo)
	__iadd__ (self, configs, descr=None)
	__getattr__ (self, attr)
	__setattr__ (self, name, value)
	__delattr__ (self, attr)
	__bool__ (self)
	remove (self, items)
	removeAll (self)
	copyChild (self, child)
	copyChildAndSetParent (self, cfg, parent)
	getChildren (self)
	getTools (self)
	children (self)
	getAllChildren (self)
	getSequence (self)
	setup (self)
	getProperties (self)
	getPropertiesWithDescription (self)
	getValuedProperties (self)
	properties (self)
	getDefaultProperties (cls)
	getDefaultProperty (cls, name)
	getProp (self, name)
	setProp (self, name, value)
	isPropertySet (self, name)
	getType (cls)
	getName (self)
	name (self)
	jobOptName (self)
	getFullJobOptName (self)
	getTitleName (self)
	setDefaults (cls, handle)
	clone (self, name=None, **kwargs)
	splitName (self)
	addTool (self, tool, name=None)
	__repr__ (self)
	__str__ (self, indent=0, headerLastIndentUnit=indentUnit)
	isApplicable (self)
Public Member Functions inherited from GaudiKernel.ConfigurableMeta.ConfigurableMeta
	__new__ (self, name, bases, dct)
	__call__ (cls, args, *kwargs)

Protected Attributes
str	_jobOptName = name
Protected Attributes inherited from GaudiKernel.Configurable.Configurable
	_name = self.__class__.DefaultedName
bool	_inSetDefaults = False
bool	_initok = True
bool	_setupok = False
bool	_unpickling = False
	_properties

Static Private Attributes
dict	__slots__

Additional Inherited Members
Public Attributes inherited from GaudiKernel.Configurable.Configurable
	configurables
Static Public Attributes inherited from GaudiKernel.Configurable.Configurable
	propertyNoValue
str	indentUnit = "\| "
int	printHeaderWidth = 100
int	printHeaderPre = 5
dict	allConfigurables = {}
dict	configurableServices = {}
Protected Member Functions inherited from GaudiKernel.Configurable.Configurable
	_isInSetDefaults (self)
Static Protected Member Functions inherited from GaudiKernel.Configurable.Configurable
	_printHeader (indentStr, title)
	_printFooter (indentStr, title)
Static Protected Attributes inherited from GaudiKernel.Configurable.Configurable
bool	_configurationLocked = False

Detailed Description

Definition at line 1227 of file Configurable.py.

Constructor & Destructor Documentation

◆ init()

GaudiKernel.Configurable.ConfigurableAlgTool.__init__	(		self,
			name = Configurable.DefaultName )

Definition at line 1235 of file Configurable.py.

    def __init__(self, name=Configurable.DefaultName):
        super().__init__(name)
        if "." not in self._name:
            # Public tools must have ToolSvc as parent
            self._name = "ToolSvc." + self._name
        name = self.getName()
        name = name[name.find("/") + 1 :]  # strips class, if any
        self._jobOptName = name
 

Member Function Documentation

◆ getFullName()

GaudiKernel.Configurable.ConfigurableAlgTool.getFullName ( self )

Reimplemented from GaudiKernel.Configurable.Configurable.

Definition at line 1309 of file Configurable.py.

    def getFullName(self):
        # for Tools, the "full name" means "Type/LocalName",
        # without the names of the parents
        name = self.getName()
        # strip off everything before the last '.'
        name = name[name.rfind(".") + 1 :]
        return str(self.getType() + "/" + name)
 
 
# FIXME: this is just a placeholder, waiting for a real implementation
# It is sufficient to get us going... (and import a PkgConf which
# happens to contain an Auditor...)

◆ getGaudiHandle()

GaudiKernel.Configurable.ConfigurableAlgTool.getGaudiHandle ( self )

Definition at line 1254 of file Configurable.py.

    def getGaudiHandle(self):
        if self.isPublic():
            return PublicToolHandle(self.toStringProperty())
        else:
            return PrivateToolHandle(self.toStringProperty())
 

◆ getGaudiType()

GaudiKernel.Configurable.ConfigurableAlgTool.getGaudiType ( cls )

Definition at line 1251 of file Configurable.py.

    def getGaudiType(cls):
        return "AlgTool"
 

◆ getHandle()

GaudiKernel.Configurable.ConfigurableAlgTool.getHandle ( self )

Definition at line 1244 of file Configurable.py.

    def getHandle(self):
        # iAlgTool isn't useful, unless one knows for sure that the tool exists
        return iProperty(  # noqa: F821 (to avoid circular dependeny)
            self.getJobOptName()
        )
 

◆ getJobOptName()

GaudiKernel.Configurable.ConfigurableAlgTool.getJobOptName ( self )

Reimplemented from GaudiKernel.Configurable.Configurable.

Definition at line 1295 of file Configurable.py.

    def getJobOptName(self):
        return self._jobOptName
 

◆ getParent()

GaudiKernel.Configurable.ConfigurableAlgTool.getParent ( self )

Reimplemented from GaudiKernel.Configurable.Configurable.

Definition at line 1285 of file Configurable.py.

    def getParent(self):
        dot = self._jobOptName.rfind(".")
        if dot != -1:
            return self._jobOptName[:dot]
        else:
            return ""
 

◆ getPrintTitle()

GaudiKernel.Configurable.ConfigurableAlgTool.getPrintTitle ( self )

Reimplemented from GaudiKernel.Configurable.Configurable.

Definition at line 1260 of file Configurable.py.

    def getPrintTitle(self):
        if self.isPublic():
            pop = "Public "
        else:
            pop = "Private "
        return pop + Configurable.getPrintTitle(self)
 

◆ hasParent()

GaudiKernel.Configurable.ConfigurableAlgTool.hasParent	(		self,
			parent )

Reimplemented from GaudiKernel.Configurable.Configurable.

Definition at line 1292 of file Configurable.py.

    def hasParent(self, parent):
        return self._jobOptName.startswith(parent + ".")
 

◆ isInToolSvc()

GaudiKernel.Configurable.ConfigurableAlgTool.isInToolSvc ( self )

Definition at line 1301 of file Configurable.py.

    def isInToolSvc(self):
        (parent, child) = self._jobOptName.rsplit(".", 1)
        return parent == "ToolSvc"
 

◆ isPublic()

GaudiKernel.Configurable.ConfigurableAlgTool.isPublic ( self )

Reimplemented from GaudiKernel.Configurable.Configurable.

Definition at line 1298 of file Configurable.py.

    def isPublic(self):
        return self.isInToolSvc()
 

◆ setParent()

GaudiKernel.Configurable.ConfigurableAlgTool.setParent	(		self,
			parentName )

Reimplemented from GaudiKernel.Configurable.Configurable.

Definition at line 1267 of file Configurable.py.

    def setParent(self, parentName):
        #       print "ConfigurableAlgTool.setParent(%s@%x,%r)" % (self.getName(),id(self),parentName)
        #       print "Calling stack:"
        #       import traceback
        #       traceback.print_stack()
 
        # Find name of this instance.
        name = self.getName()
        instance = name[name.rfind(".") + 1 :]
 
        # propagate parent to AlgTools in children
        for c in self.getAllChildren():
            if isinstance(c, ConfigurableAlgTool):
                c.setParent(parentName + "." + instance)
 
        # update my own parent
        self._jobOptName = self._name = parentName + "." + instance
 

◆ toStringProperty()

GaudiKernel.Configurable.ConfigurableAlgTool.toStringProperty ( self )

Definition at line 1305 of file Configurable.py.

    def toStringProperty(self):
        # called on conversion to a string property for the jocat
        return self.getFullName()
 

Member Data Documentation

◆ slots

dict GaudiKernel.Configurable.ConfigurableAlgTool.__slots__

staticprivate

Initial value:

=  {
        "_jobOptName": "",
        "OutputLevel": 0,
        "AuditInitialize": 0,
        "AuditFinalize": 0,
    }

Definition at line 1228 of file Configurable.py.

◆ _jobOptName

str GaudiKernel.Configurable.ConfigurableAlgTool._jobOptName = name

protected

Definition at line 1242 of file Configurable.py.

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

GaudiKernel/python/GaudiKernel/Configurable.py

Public Member Functions

Protected Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ getFullName()

◆ getGaudiHandle()

◆ getGaudiType()

◆ getHandle()

◆ getJobOptName()

◆ getParent()

◆ getPrintTitle()

◆ hasParent()

◆ isInToolSvc()

◆ isPublic()

◆ setParent()

◆ toStringProperty()

Member Data Documentation

◆ __slots__

◆ _jobOptName

◆ init()

◆ slots