Gaudi Framework, version v23r5

Home   Generated: Wed Nov 28 2012
 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 1006 of file Configurable.py.

Constructor & Destructor Documentation

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

Definition at line 1010 of file Configurable.py.

1011  def __init__( self, name = Configurable.DefaultName ):
1012  super( ConfigurableAlgTool, self ).__init__( name )
1013  if '.' not in self._name:
1014  # Public tools must have ToolSvc as parent
1015  self._name = "ToolSvc." + self._name
1016  name = self.getName()
1017  name = name[ name.find('/')+1 : ] # strips class, if any
1018  self._jobOptName = name

Member Function Documentation

def GaudiKernel.Configurable.ConfigurableAlgTool.getFullName (   self)

Definition at line 1076 of file Configurable.py.

1077  def getFullName( self ) :
1078  # for Tools, the "full name" means "Type/LocalName",
1079  # without the names of the parents
1080  name = self.getName()
1081  # strip off everything before the last '.'
1082  name = name[name.rfind('.')+1:]
1083  return str( self.getType() + '/' + name )
1084 
def GaudiKernel.Configurable.ConfigurableAlgTool.getGaudiHandle (   self)

Definition at line 1026 of file Configurable.py.

1027  def getGaudiHandle( self ):
1028  if self.isPublic():
1029  return PublicToolHandle( self.toStringProperty() )
1030  else:
1031  return PrivateToolHandle( self.toStringProperty() )
def GaudiKernel.Configurable.ConfigurableAlgTool.getGaudiType (   self)

Definition at line 1023 of file Configurable.py.

1024  def getGaudiType( self ):
1025  return 'AlgTool'
def GaudiKernel.Configurable.ConfigurableAlgTool.getHandle (   self)

Definition at line 1019 of file Configurable.py.

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

Definition at line 1063 of file Configurable.py.

1064  def getJobOptName( self ):
1065  return self._jobOptName
def GaudiKernel.Configurable.ConfigurableAlgTool.getParent (   self)

Definition at line 1053 of file Configurable.py.

1054  def getParent( self ):
1055  dot = self._jobOptName.rfind('.')
1056  if dot != -1:
1057  return self._jobOptName[:dot]
1058  else:
1059  return ""
def GaudiKernel.Configurable.ConfigurableAlgTool.getPrintTitle (   self)

Definition at line 1032 of file Configurable.py.

1033  def getPrintTitle(self):
1034  if self.isPublic():
1035  pop = 'Public '
1036  else:
1037  pop = 'Private '
1038  return pop + Configurable.getPrintTitle(self)
def GaudiKernel.Configurable.ConfigurableAlgTool.hasParent (   self,
  parent 
)

Definition at line 1060 of file Configurable.py.

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

Definition at line 1069 of file Configurable.py.

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

Definition at line 1066 of file Configurable.py.

1067  def isPublic( self ):
1068  return self.isInToolSvc()
def GaudiKernel.Configurable.ConfigurableAlgTool.setParent (   self,
  parentName 
)

Definition at line 1039 of file Configurable.py.

1040  def setParent( self, parentName ):
1041 # print "ConfigurableAlgTool.setParent(%s@%x,%r)" % (self.getName(),id(self),parentName)
1042 # print "Calling stack:"
1043 # import traceback
1044 # traceback.print_stack()
1045  # propagate parent to AlgTools in children
1046  for c in self.getAllChildren():
1047  if isinstance(c,ConfigurableAlgTool): c.setParent( parentName )
1048 
1049  # update my own parent
1050  name = self.getName()
1051  name = name[name.rfind('.')+1:] # Name of the instance
1052  self._jobOptName = self._name = parentName + '.' + name
def GaudiKernel.Configurable.ConfigurableAlgTool.toStringProperty (   self)

Definition at line 1072 of file Configurable.py.

1073  def toStringProperty( self ):
1074  # called on conversion to a string property for the jocat
1075  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 1007 of file Configurable.py.

GaudiKernel.Configurable.ConfigurableAlgTool._jobOptName
private

Definition at line 1017 of file Configurable.py.

GaudiKernel.Configurable.ConfigurableAlgTool._name
private

Definition at line 1014 of file Configurable.py.


The documentation for this class was generated from the following file:
Generated at Wed Nov 28 2012 12:17:39 for Gaudi Framework, version v23r5 by Doxygen version 1.8.2 written by Dimitri van Heesch, © 1997-2004