GaudiKernel.Configurable.ConfigurableAlgTool Class Reference

Inheritance diagram for GaudiKernel.Configurable.ConfigurableAlgTool:

Collaboration diagram for GaudiKernel.Configurable.ConfigurableAlgTool:

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

Private Attributes
	_name
	_jobOptName

Static Private Attributes
	__slots__

Additional Inherited Members
Static Public Attributes inherited from GaudiKernel.Configurable.Configurable
	propertyNoValue
	indentUnit
	printHeaderWidth
	printHeaderPre
	allConfigurables
	configurableServices

Detailed Description

Definition at line 1242 of file Configurable.py.

Constructor & Destructor Documentation

__init__()

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

Reimplemented from GaudiKernel.Configurable.Configurable.

Definition at line 1251 of file Configurable.py.

    def __init__(self, name=Configurable.DefaultName):
        super(ConfigurableAlgTool, self).__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()

def GaudiKernel.Configurable.ConfigurableAlgTool.getFullName

(

self

)

Reimplemented from GaudiKernel.Configurable.Configurable.

Definition at line 1322 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()

def GaudiKernel.Configurable.ConfigurableAlgTool.getGaudiHandle

(

self

)

Definition at line 1270 of file Configurable.py.

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

getGaudiType()

def GaudiKernel.Configurable.ConfigurableAlgTool.getGaudiType

(

cls

)

Definition at line 1267 of file Configurable.py.

    def getGaudiType(cls):
        return "AlgTool"
 

getHandle()

def GaudiKernel.Configurable.ConfigurableAlgTool.getHandle

(

self

)

Definition at line 1260 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()

def GaudiKernel.Configurable.ConfigurableAlgTool.getJobOptName

(

self

)

Reimplemented from GaudiKernel.Configurable.Configurable.

Definition at line 1308 of file Configurable.py.

    def getJobOptName(self):
        return self._jobOptName
 

getParent()

def GaudiKernel.Configurable.ConfigurableAlgTool.getParent

(

self

)

Reimplemented from GaudiKernel.Configurable.Configurable.

Definition at line 1298 of file Configurable.py.

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

getPrintTitle()

def GaudiKernel.Configurable.ConfigurableAlgTool.getPrintTitle

(

self

)

Reimplemented from GaudiKernel.Configurable.Configurable.

Definition at line 1276 of file Configurable.py.

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

hasParent()

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

Reimplemented from GaudiKernel.Configurable.Configurable.

Definition at line 1305 of file Configurable.py.

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

isInToolSvc()

def GaudiKernel.Configurable.ConfigurableAlgTool.isInToolSvc

(

self

)

Definition at line 1314 of file Configurable.py.

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

isPublic()

def GaudiKernel.Configurable.ConfigurableAlgTool.isPublic

(

self

)

Reimplemented from GaudiKernel.Configurable.Configurable.

Definition at line 1311 of file Configurable.py.

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

setParent()

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

Reimplemented from GaudiKernel.Configurable.Configurable.

Definition at line 1283 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()
        # propagate parent to AlgTools in children
        for c in self.getAllChildren():
            if isinstance(c, ConfigurableAlgTool):
                c.setParent(parentName)
 
        # update my own parent
        name = self.getName()
        name = name[name.rfind(".") + 1 :]  # Name of the instance
        self._jobOptName = self._name = parentName + "." + name
 

toStringProperty()

def GaudiKernel.Configurable.ConfigurableAlgTool.toStringProperty

(

self

)

Definition at line 1318 of file Configurable.py.

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

Member Data Documentation

__slots__

GaudiKernel.Configurable.ConfigurableAlgTool.__slots__

staticprivate

Definition at line 1243 of file Configurable.py.

_jobOptName

GaudiKernel.Configurable.ConfigurableAlgTool._jobOptName

private

Definition at line 1258 of file Configurable.py.

_name

GaudiKernel.Configurable.ConfigurableAlgTool._name

private

Definition at line 1255 of file Configurable.py.

---

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

• GaudiKernel/python/GaudiKernel/Configurable.py