GaudiKernel.PropertyProxy.GaudiHandleArrayPropertyProxy Class Reference

Inheritance diagram for GaudiKernel.PropertyProxy.GaudiHandleArrayPropertyProxy:

Collaboration diagram for GaudiKernel.PropertyProxy.GaudiHandleArrayPropertyProxy:

Public Member Functions
	__init__ (self, descr, docString, default)
	checkType (self, obj, value)
	convertDefaultToBeSet (self, obj, default)
	convertValueToBeSet (self, obj, value)
Public Member Functions inherited from GaudiKernel.PropertyProxy.GaudiHandlePropertyProxyBase
	__init__ (self, descr, docString, default, handleType, allowedType)
	__get__ (self, obj, type=None)
	__set__ (self, obj, value)
	isHandle (self, value)
	isConfig (self, value)
	getDefaultConfigurable (self, typeAndName, requester)
Public Member Functions inherited from GaudiKernel.PropertyProxy.PropertyProxy
	__init__ (self, descr, docString=None, default=None)
	setDefault (self, value)
	getDefault (self)
	fullPropertyName (self, obj)
	__get__ (self, obj, type=None)
	__set__ (self, obj, value)
	__delete__ (self, obj)

Public Attributes
	arrayType = type(default)
Public Attributes inherited from GaudiKernel.PropertyProxy.PropertyProxy
dict	history = {}
	descr = descr
bool	deprecated = False

Additional Inherited Members
Protected Attributes inherited from GaudiKernel.PropertyProxy.GaudiHandlePropertyProxyBase
	_handleType = handleType
str	_confTypeName = "Configurable" + handleType.componentType
Properties inherited from GaudiKernel.PropertyProxy.PropertyProxy
	default = property(getDefault, setDefault)

Detailed Description

Definition at line 373 of file PropertyProxy.py.

Constructor & Destructor Documentation

__init__()

GaudiKernel.PropertyProxy.GaudiHandleArrayPropertyProxy.__init__	(		self,
			descr,
			docString,
			default )

<descr>: the real property in the object instance (from __slots__)
<confTypeName>: string indicating the (base) class of allowed Configurables to be assigned.
<handleType>: real python handle type (e.g. PublicToolHandle, PrivateToolHandle, ...)

Definition at line 374 of file PropertyProxy.py.

    def __init__(self, descr, docString, default):
        """<descr>: the real property in the object instance (from __slots__)
        <confTypeName>: string indicating the (base) class of allowed Configurables to be assigned.
        <handleType>: real python handle type (e.g. PublicToolHandle, PrivateToolHandle, ...)
        """
        GaudiHandlePropertyProxyBase.__init__(
            self, descr, docString, default, type(default).handleType, GaudiHandleArray
        )
        self.arrayType = type(default)
 

Member Function Documentation

checkType()

GaudiKernel.PropertyProxy.GaudiHandleArrayPropertyProxy.checkType	(		self,
			obj,
			value )

Definition at line 384 of file PropertyProxy.py.

    def checkType(self, obj, value):
        if not isinstance(value, list) and not isinstance(value, self.arrayType):
            raise TypeError(
                f"{self.fullPropertyName(obj)}: Value {value!r} is not a list nor a {self.arrayType.__name__}"
            )
 

convertDefaultToBeSet()

GaudiKernel.PropertyProxy.GaudiHandleArrayPropertyProxy.convertDefaultToBeSet	(		self,
			obj,
			default )

Reimplemented from GaudiKernel.PropertyProxy.GaudiHandlePropertyProxyBase.

Definition at line 390 of file PropertyProxy.py.

    def convertDefaultToBeSet(self, obj, default):
        self.checkType(obj, default)
        newDefault = self.arrayType()
        for d in default:
            cd = GaudiHandlePropertyProxyBase.convertDefaultToBeSet(self, obj, d)
            if cd:
                newDefault.append(cd)
 
        return newDefault
 

convertValueToBeSet()

GaudiKernel.PropertyProxy.GaudiHandleArrayPropertyProxy.convertValueToBeSet	(		self,
			obj,
			value )

Reimplemented from GaudiKernel.PropertyProxy.GaudiHandlePropertyProxyBase.

Definition at line 400 of file PropertyProxy.py.

    def convertValueToBeSet(self, obj, value):
        self.checkType(obj, value)
        newValue = self.arrayType()
        for v in value:
            cv = GaudiHandlePropertyProxyBase.convertValueToBeSet(self, obj, v)
            if cv:
                newValue.append(cv)
 
        return newValue
 
 

Member Data Documentation

arrayType

GaudiKernel.PropertyProxy.GaudiHandleArrayPropertyProxy.arrayType = type(default)

Definition at line 382 of file PropertyProxy.py.

---

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

• GaudiKernel/python/GaudiKernel/PropertyProxy.py