Gaudi Framework, version v25r2

Home   Generated: Wed Jun 4 2014
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Private Attributes | Static Private Attributes | List of all members
GaudiKernel.Configurable.ConfigurableAlgTool Class Reference
Inheritance diagram for GaudiKernel.Configurable.ConfigurableAlgTool:
Inheritance graph
[legend]
Collaboration diagram for GaudiKernel.Configurable.ConfigurableAlgTool:
Collaboration graph
[legend]

Public Member Functions

def __init__
 
def getHandle
 
def getGaudiType
 
def getGaudiHandle
 
def getPrintTitle
 
def setParent
 
def getParent
 
def hasParent
 
def getJobOptName
 
def isPublic
 
def isInToolSvc
 
def toStringProperty
 
def getFullName
 
- Public Member Functions inherited from GaudiKernel.Configurable.Configurable
def __new__
 
def __init__
 
def __getstate__
 
def __getnewargs__
 
def __setstate__
 
def __len__
 
def __iter__
 
def __deepcopy__
 
def __iadd__
 
def __getattr__
 
def __setattr__
 
def __delattr__
 
def __nonzero__
 
def remove
 
def removeAll
 
def copyChild
 
def setParent
 
def getParent
 
def hasParent
 
def copyChildAndSetParent
 
def getChildren
 
def getTools
 
def children
 
def getAllChildren
 
def getSequence
 
def setup
 
def getProperties
 
def getValuedProperties
 
def properties
 
def getDefaultProperties
 
def getDefaultProperty
 
def getProp
 
def setProp
 
def isPropertySet
 
def getType
 
def getName
 
def name
 
def getJobOptName
 
def isPublic
 
def jobOptName
 
def getFullName
 
def getFullJobOptName
 
def getPrintTitle
 
def getTitleName
 
def setDefaults
 
def clone
 
def splitName
 
def addTool
 
def __repr__
 
def __str__
 

Private Attributes

 _name
 
 _jobOptName
 

Static Private Attributes

dictionary __slots__
 

Additional Inherited Members

- Static Public Attributes inherited from GaudiKernel.Configurable.Configurable
string indentUnit '| '
 
int printHeaderWidth 100
 
int printHeaderPre 5
 
dictionary allConfigurables {}
 
dictionary configurableServices {}
 

Detailed Description

Definition at line 1015 of file Configurable.py.

Constructor & Destructor Documentation

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

Definition at line 1019 of file Configurable.py.

1020  def __init__( self, name = Configurable.DefaultName ):
1021  super( ConfigurableAlgTool, self ).__init__( name )
1022  if '.' not in self._name:
1023  # Public tools must have ToolSvc as parent
1024  self._name = "ToolSvc." + self._name
1025  name = self.getName()
1026  name = name[ name.find('/')+1 : ] # strips class, if any
1027  self._jobOptName = name

Member Function Documentation

def GaudiKernel.Configurable.ConfigurableAlgTool.getFullName (   self)

Definition at line 1085 of file Configurable.py.

1086  def getFullName( self ) :
1087  # for Tools, the "full name" means "Type/LocalName",
1088  # without the names of the parents
1089  name = self.getName()
1090  # strip off everything before the last '.'
1091  name = name[name.rfind('.')+1:]
1092  return str( self.getType() + '/' + name )
1093 
def GaudiKernel.Configurable.ConfigurableAlgTool.getGaudiHandle (   self)

Definition at line 1035 of file Configurable.py.

1036  def getGaudiHandle( self ):
1037  if self.isPublic():
1038  return PublicToolHandle( self.toStringProperty() )
1039  else:
1040  return PrivateToolHandle( self.toStringProperty() )
def GaudiKernel.Configurable.ConfigurableAlgTool.getGaudiType (   self)

Definition at line 1032 of file Configurable.py.

1033  def getGaudiType( self ):
1034  return 'AlgTool'
def GaudiKernel.Configurable.ConfigurableAlgTool.getHandle (   self)

Definition at line 1028 of file Configurable.py.

1029  def getHandle( self ):
1030  # iAlgTool isn't useful, unless one knows for sure that the tool exists
1031  return iProperty( self.getJobOptName() )
def GaudiKernel.Configurable.ConfigurableAlgTool.getJobOptName (   self)

Definition at line 1072 of file Configurable.py.

1073  def getJobOptName( self ):
1074  return self._jobOptName
def GaudiKernel.Configurable.ConfigurableAlgTool.getParent (   self)

Definition at line 1062 of file Configurable.py.

1063  def getParent( self ):
1064  dot = self._jobOptName.rfind('.')
1065  if dot != -1:
1066  return self._jobOptName[:dot]
1067  else:
1068  return ""
def GaudiKernel.Configurable.ConfigurableAlgTool.getPrintTitle (   self)

Definition at line 1041 of file Configurable.py.

1042  def getPrintTitle(self):
1043  if self.isPublic():
1044  pop = 'Public '
1045  else:
1046  pop = 'Private '
1047  return pop + Configurable.getPrintTitle(self)
def GaudiKernel.Configurable.ConfigurableAlgTool.hasParent (   self,
  parent 
)

Definition at line 1069 of file Configurable.py.

1070  def hasParent( self, parent ):
1071  return self._jobOptName.startswith( parent + '.' )
def GaudiKernel.Configurable.ConfigurableAlgTool.isInToolSvc (   self)

Definition at line 1078 of file Configurable.py.

1079  def isInToolSvc( self ):
1080  return self._jobOptName.startswith('ToolSvc.')
def GaudiKernel.Configurable.ConfigurableAlgTool.isPublic (   self)

Definition at line 1075 of file Configurable.py.

1076  def isPublic( self ):
1077  return self.isInToolSvc()
def GaudiKernel.Configurable.ConfigurableAlgTool.setParent (   self,
  parentName 
)

Definition at line 1048 of file Configurable.py.

1049  def setParent( self, parentName ):
1050 # print "ConfigurableAlgTool.setParent(%s@%x,%r)" % (self.getName(),id(self),parentName)
1051 # print "Calling stack:"
1052 # import traceback
1053 # traceback.print_stack()
1054  # propagate parent to AlgTools in children
1055  for c in self.getAllChildren():
1056  if isinstance(c,ConfigurableAlgTool): c.setParent( parentName )
1057 
1058  # update my own parent
1059  name = self.getName()
1060  name = name[name.rfind('.')+1:] # Name of the instance
1061  self._jobOptName = self._name = parentName + '.' + name
def GaudiKernel.Configurable.ConfigurableAlgTool.toStringProperty (   self)

Definition at line 1081 of file Configurable.py.

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

Member Data Documentation

dictionary GaudiKernel.Configurable.ConfigurableAlgTool.__slots__
staticprivate
Initial value:
1 { '_jobOptName' : '', 'OutputLevel' : 0, \
2  'AuditTools' : 0, 'AuditInitialize' : 0, 'AuditFinalize' : 0 }

Definition at line 1016 of file Configurable.py.

GaudiKernel.Configurable.ConfigurableAlgTool._jobOptName
private

Definition at line 1026 of file Configurable.py.

GaudiKernel.Configurable.ConfigurableAlgTool._name
private

Definition at line 1023 of file Configurable.py.


The documentation for this class was generated from the following file:
Generated at Wed Jun 4 2014 14:49:05 for Gaudi Framework, version v25r2 by Doxygen version 1.8.2 written by Dimitri van Heesch, © 1997-2004