Gaudi Framework, version v25r0

Home   Generated: Mon Feb 17 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 1014 of file Configurable.py.

Constructor & Destructor Documentation

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

Definition at line 1018 of file Configurable.py.

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

Member Function Documentation

def GaudiKernel.Configurable.ConfigurableAlgTool.getFullName (   self)

Definition at line 1084 of file Configurable.py.

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

Definition at line 1034 of file Configurable.py.

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

Definition at line 1031 of file Configurable.py.

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

Definition at line 1027 of file Configurable.py.

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

Definition at line 1071 of file Configurable.py.

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

Definition at line 1061 of file Configurable.py.

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

Definition at line 1040 of file Configurable.py.

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

Definition at line 1068 of file Configurable.py.

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

Definition at line 1077 of file Configurable.py.

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

Definition at line 1074 of file Configurable.py.

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

Definition at line 1047 of file Configurable.py.

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

Definition at line 1080 of file Configurable.py.

1081  def toStringProperty( self ):
1082  # called on conversion to a string property for the jocat
1083  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 1015 of file Configurable.py.

GaudiKernel.Configurable.ConfigurableAlgTool._jobOptName
private

Definition at line 1025 of file Configurable.py.

GaudiKernel.Configurable.ConfigurableAlgTool._name
private

Definition at line 1022 of file Configurable.py.


The documentation for this class was generated from the following file:
Generated at Mon Feb 17 2014 14:38:18 for Gaudi Framework, version v25r0 by Doxygen version 1.8.2 written by Dimitri van Heesch, © 1997-2004