GaudiHandles::GaudiHandleArray Class Reference

Inheritance diagram for GaudiHandles::GaudiHandleArray:

List of all members.

Public Member Functions
def	__init__
def	__repr__
def	__str__
def	__getitem__
def	__delitem__
def	__iadd__
def	append
def	isPublic
def	toStringProperty
def	__getstate__
def	__setstate__
Public Attributes
	typesAndNames
Static Public Attributes
	handleType = None
Static Private Attributes
tuple	__slots__ = ( 'typesAndNames' )

---

Detailed Description

A list of GaudiHandles. Only handles of one type are allowed, as specified by self.__class__.handleType

Definition at line 100 of file GaudiHandles.py.

---

Constructor & Destructor Documentation

def GaudiHandles::GaudiHandleArray::__init__	(		self,
			typesAndNames = None
	)

Reimplemented in GaudiHandles::ServiceHandleArray, GaudiHandles::PublicToolHandleArray, and GaudiHandles::PrivateToolHandleArray.

Definition at line 106 of file GaudiHandles.py.

                                         :
        if typesAndNames is None: typesAndNames = []
        list.__init__(self)
        # check the type
        if type(typesAndNames) != list:
            raise TypeError("Argument to %s must be a list. Got a %s instead" % \
                            ( self.__class__.__name__, type(typesAndNames).__name__) )
        # add entries to list
        for tn in typesAndNames: self.append( tn )

---

Member Function Documentation

def GaudiHandles::GaudiHandleArray::__delitem__	(		self,
			key
	)

Definition at line 141 of file GaudiHandles.py.

                                :
        super( GaudiHandleArray, self ).__delitem__( self.index(self[key]) )

def GaudiHandles::GaudiHandleArray::__getitem__	(		self,
			index
	)

Definition at line 130 of file GaudiHandles.py.

                               :
        if type(index) == str:
            # seach by instance name
            for h in self:
                if h.getName() == index:
                    return h
            raise IndexError( "%s does not have a %s with instance name %s" % \
                              (self.__class__.__name__, self.handleType.componentType, index) )
        else:
            return list.__getitem__(self,index)

def GaudiHandles::GaudiHandleArray::__getstate__

(

self )

Definition at line 202 of file GaudiHandles.py.

                           :
        return { 'typesAndNames' : self.typesAndNames }

def GaudiHandles::GaudiHandleArray::__iadd__	(		self,
			array
	)

Definition at line 144 of file GaudiHandles.py.

                            :
        arrayType = type(array)
        if arrayType == list or arrayType == type(self):
            for v in array:
                self.append( v )
        else:
            raise TypeError( "Can not add a %s to a %s" % (arrayType.__name__, self.__class__.__name__) )

        return self

def GaudiHandles::GaudiHandleArray::__repr__

(

self )

Return class name with list of type/name strings as argument

Definition at line 116 of file GaudiHandles.py.

                      :
        """Return class name with list of type/name strings as argument"""
        rep = self.__class__.__name__ + '(['
        for h in self:
            rep += repr(h.toStringProperty()) + ','
        # remove last comma
        if rep[-1] == ',': rep = rep[:-1]
        return rep + '])'

def GaudiHandles::GaudiHandleArray::__setstate__	(		self,
			dict
	)

Definition at line 205 of file GaudiHandles.py.

                                   :
        self.typesAndNames = dict[ 'typesAndNames' ]

def GaudiHandles::GaudiHandleArray::__str__

(

self )

Print entries, one per line

Definition at line 125 of file GaudiHandles.py.

                     :
        """Print entries, one per line"""
        shortName = self.__class__.__name__
        return "%s:%s" % (shortName, linesep + linesep.join([str(s) for s in self]))

def GaudiHandles::GaudiHandleArray::append	(		self,
			value
	)

Only allow appending compatible types. It accepts a string, a handle or a configurable.

Definition at line 154 of file GaudiHandles.py.

                             :
        """Only allow appending compatible types. It accepts a string, a handle or a configurable."""
        if type(value) == str:
            # convert string to handle
            value = self.__class__.handleType(value)
        elif type(value) == self.__class__.handleType:
            pass # leave handle as-is
        elif isinstance( value, GaudiHandle ):
            # do not allow different type of handles
            raise TypeError( "Can not add a %s to a %s" % (value.__class__.__name__, self.__class__.__name__) )
        elif value.getGaudiType() != self.__class__.handleType.componentType:
            # assume it is a configurable: allow only correct types
            raise TypeError( "Can not append %s (%s) to a %s" % \
                             (value.__class__.__name__, value.getGaudiType(), self.__class__.__name__) )
        elif hasattr(value,'isPublic'):
            # check public vs private if applicable for this configurable
            pop = value.isPublic() and 'Public' or 'Private'
            if value.isPublic() != self.__class__.handleType.isPublic:
                raise TypeError( "Can not append %s (%s %s) to a %s" % \
                                 (value.__class__.__name__, pop, value.getGaudiType(), self.__class__.__name__) )

        # check that an instance name appears only once in the list
        try:
            oldValue = self.__getitem__( value.getName() )
        except IndexError:
            # not yet there, so add it
            list.append( self, value )
        else:
            print "%s    WARNING %r with instance name %r already in list. Not adding %r" % \
                  (self.__class__.__name__, oldValue, oldValue.getName(), value)

def GaudiHandles::GaudiHandleArray::isPublic

(

self )

Definition at line 186 of file GaudiHandles.py.

                      :
        return self.__class__.handleType.isPublic

def GaudiHandles::GaudiHandleArray::toStringProperty

(

self )

Definition at line 192 of file GaudiHandles.py.

                              :
        rep = '['
        # add entries
        for v in self:
            rep += repr( v.toStringProperty() ) + ','
        # remove last comma
        if rep[-1] == ',': rep = rep[:-1]
        return rep + ']'

---

Member Data Documentation

tuple GaudiHandles::GaudiHandleArray::__slots__ = ( 'typesAndNames' ) [static, private]

Reimplemented in GaudiHandles::ServiceHandleArray, GaudiHandles::PublicToolHandleArray, and GaudiHandles::PrivateToolHandleArray.

Definition at line 103 of file GaudiHandles.py.

GaudiHandles::GaudiHandleArray::handleType = None [static]

Reimplemented in GaudiHandles::ServiceHandleArray, GaudiHandles::PublicToolHandleArray, and GaudiHandles::PrivateToolHandleArray.

Definition at line 104 of file GaudiHandles.py.

GaudiHandles::GaudiHandleArray::typesAndNames

Definition at line 205 of file GaudiHandles.py.

---

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

• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v23r2p1/GaudiKernel/python/GaudiKernel/GaudiHandles.py