GaudiKernel.Configurable.Configurable Class Reference

Inheritance diagram for GaudiKernel.Configurable.Configurable:

Collaboration diagram for GaudiKernel.Configurable.Configurable:

Classes
class	DefaultName
	for detecting the default name More...

Public Member Functions
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__

Static Public Attributes
string	indentUnit '| '
int	printHeaderWidth 100
int	printHeaderPre 5
dictionary	allConfigurables {}
dictionary	configurableServices {}

Private Member Functions
def	_isInSetDefaults
def	__setupServices
def	__setupDlls
def	__setupDefaults

Static Private Member Functions
def	_printHeader
def	_printFooter

Private Attributes
	__children
	__tools
	_name
	_inSetDefaults
	_initok
	_setupok

Static Private Attributes
	__metaclass__ ConfigurableMeta.ConfigurableMeta
tuple	__slots__
	_configurationLocked False

Detailed Description

Base class for Gaudi components that implement the IProperty interface.
   Provides most of the boilerplate code, but the actual useful classes
   are its derived ConfigurableAlgorithm, ConfigurableService, and
   ConfigurableAlgTool.

Definition at line 87 of file Configurable.py.

Constructor & Destructor Documentation

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

Definition at line 254 of file Configurable.py.

    def __init__( self, name = DefaultName ):
        # check class readiness, all required overloads should be there now
        klass = self.__class__

        # this is an abstract class
        if klass == Configurable:
            raise TypeError, "%s is an ABC and can not be instantiated" % str(Configurable)

        # the following methods require overloading
        #NOT YET  meths = { 'getServices'   : 1,    # retrieve list of services to configure
        meths = { 'getDlls'       : 1,    # provide list of Dlls to load
                  'getGaudiType'  : 1,    # return string describing component class
                  'getHandle'     : 1 }   # provide access to C++ side component instance
#                'getType'       : 1 }   # return the type of the actual C++ component

        for meth, nArgs in meths.items():
            try:
                f = getattr( klass, meth ).im_func
            except AttributeError:
                raise NotImplementedError, "%s is missing in class %s" % (meth,str(klass))

            # in addition, verify the number of arguments w/o defaults
            nargcount = f.func_code.co_argcount
            ndefaults = f.func_defaults and len(f.func_defaults) or 0
            if not nargcount - ndefaults <= nArgs <= nargcount:
                raise TypeError, "%s.%s requires exactly %d arguments" % (klass,meth,nArgs)

        # for using this Configurable as a (Gaudi) sequence
        self.__children = []
        self.__tools = {}

        # know who we are
        if name == Configurable.DefaultName :
            if hasattr(self.__class__, 'DefaultedName' ) :
                self._name = self.__class__.DefaultedName
            else :
                self._name = self.getType()
        else :
            self._name = name

        # set to True when collecting defaults, False otherwise
        self._inSetDefaults = False

        # for later, in case __init__ itself is overridden
        self._initok = True

        # for debugging purposes (temporary)
        self._setupok = False