GaudiKernel.GaudiHandles.GaudiHandleArray Class Reference

Inheritance diagram for GaudiKernel.GaudiHandles.GaudiHandleArray:

Collaboration diagram for GaudiKernel.GaudiHandles.GaudiHandleArray:

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 GaudiKernel.GaudiHandles.GaudiHandleArray.__init__	(	self,
		typesAndNames = `None`
	)

Definition at line 106 of file GaudiHandles.py.

 
     def __init__(self,typesAndNames=None):
         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 GaudiKernel.GaudiHandles.GaudiHandleArray.__delitem__	(	self,
		key
	)

Definition at line 141 of file GaudiHandles.py.

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

def GaudiKernel.GaudiHandles.GaudiHandleArray.__getitem__	(	self,
		index
	)

Definition at line 130 of file GaudiHandles.py.

 
     def __getitem__(self,index):
         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 GaudiKernel.GaudiHandles.GaudiHandleArray.__getstate__ ( self )

Definition at line 202 of file GaudiHandles.py.

 
     def __getstate__ (self):
         return { 'typesAndNames' : self.typesAndNames }

def GaudiKernel.GaudiHandles.GaudiHandleArray.__iadd__	(	self,
		array
	)

Definition at line 144 of file GaudiHandles.py.

 
     def __iadd__(self,array):
         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 GaudiKernel.GaudiHandles.GaudiHandleArray.__repr__ ( self )

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

Definition at line 116 of file GaudiHandles.py.

 
     def __repr__(self):
         """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 GaudiKernel.GaudiHandles.GaudiHandleArray.__setstate__	(	self,
		dict
	)

Definition at line 205 of file GaudiHandles.py.

 
     def __setstate__ ( self, dict ):
         self.typesAndNames = dict[ 'typesAndNames' ]

def GaudiKernel.GaudiHandles.GaudiHandleArray.__str__ ( self )

Print entries, one per line

Definition at line 125 of file GaudiHandles.py.

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

def GaudiKernel.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.

 
     def append( self, value ):
         """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 GaudiKernel.GaudiHandles.GaudiHandleArray.isPublic ( self )

Definition at line 186 of file GaudiHandles.py.

 
     def isPublic(self):
         return self.__class__.handleType.isPublic

def GaudiKernel.GaudiHandles.GaudiHandleArray.toStringProperty ( self )

Definition at line 192 of file GaudiHandles.py.

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

Gaudi Framework, version v23r5

Public Member Functions

Public Attributes

Static Public Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation