GaudiPython.Bindings.iProperty Class Reference

Inheritance diagram for GaudiPython.Bindings.iProperty:

Collaboration diagram for GaudiPython.Bindings.iProperty:

Public Member Functions
def	__init__ (self, name, ip=None)
def	getInterface (self)
def	retrieveInterface (self)
def	__call_interface_method__ (self, ifname, method, *args)
def	__setattr__ (self, name, value)
def	__getattr__ (self, name)
def	properties (self)
def	name (self)

Detailed Description

Python equivalent to the C++ Property interface 

Definition at line 238 of file Bindings.py.

Constructor & Destructor Documentation

__init__()

def GaudiPython.Bindings.iProperty.__init__	(		self,
			name,
			ip = None
	)

Reimplemented in GaudiPython.Bindings.iJobOptSvc, GaudiPython.Bindings.iToolSvc, GaudiPython.Bindings.iNTupleSvc, GaudiPython.Bindings.iHistogramSvc, GaudiPython.Bindings.iDataSvc, GaudiPython.Bindings.iAlgTool, GaudiPython.Bindings.iAlgorithm, and GaudiPython.Bindings.iService.

Definition at line 241 of file Bindings.py.

    def __init__(self, name, ip=None):
        if ip:
            self.__dict__['_ip'] = InterfaceCast(gbl.IProperty)(ip)
        else:
            self.__dict__['_ip'] = None
        self.__dict__['_svcloc'] = gbl.Gaudi.svcLocator()
        optsvc = Helper.service(self._svcloc, 'JobOptionsSvc')
        if optsvc:
            self.__dict__['_optsvc'] = InterfaceCast(
                gbl.IJobOptionsSvc)(optsvc)
        else:
            self.__dict__['_optsvc'] = None
        self.__dict__['_name'] = name

Member Function Documentation

__call_interface_method__()

def GaudiPython.Bindings.iProperty.__call_interface_method__	(		self,
			ifname,
			method,
		*	args
	)

Definition at line 263 of file Bindings.py.

    def __call_interface_method__(self, ifname, method, *args):
        if not getattr(self, ifname):
            self.retrieveInterface()
        return getattr(getattr(self, ifname), method)(*args)

__getattr__()

def GaudiPython.Bindings.iProperty.__getattr__	(		self,
			name
	)

The method which returns the value for the given property
- In the case of the valid instance it returns the valid property value through IProperty interface
- In the case of placeholder the property value is retrieved from JobOptionsCatalogue

Definition at line 324 of file Bindings.py.

    def __getattr__(self, name):
        """
        The method which returns the value for the given property
        - In the case of the valid instance it returns the valid property value through IProperty interface
        - In the case of placeholder the property value is retrieved from JobOptionsCatalogue
        """
        ip = self.getInterface()
        if ip:
            if not gbl.Gaudi.Utils.hasProperty(ip, name):
                raise AttributeError('property %s does not exist' % name)
            prop = ip.getProperty(name)
            if StringProperty == type(prop):
                return prop.value()
            elif StringPropertyRef == type(prop):
                return prop.value()
            try:
                return eval(prop.toString(), {}, {})
            except:
                return prop.value()
        else:
            props = self._optsvc.getProperties(self._name)
            for p in props:
                if not p.name() == name:
                    continue
                # from JobOptionsSvc we always have only strings
                try:
                    return eval(p.value(), {}, {})
                except:
                    return p.value()
            raise AttributeError('property %s does not exist' % name)

__setattr__()

def GaudiPython.Bindings.iProperty.__setattr__	(		self,
			name,
			value
	)

The method which is used for setting the property from the given value.
- In the case of the valid instance it sets the property through IProperty interface
- In the case of placeholder the property is added to JobOptionsCatalogue

Definition at line 268 of file Bindings.py.

    def __setattr__(self, name, value):
        """
        The method which is used for setting the property from the given value.
        - In the case of the valid instance it sets the property through IProperty interface
        - In the case of placeholder the property is added to JobOptionsCatalogue
        """
        if hasattr(value, 'toStringProperty'):
            # user defined behaviour
            value = '%s' % value.toStringProperty()
        ip = self.getInterface()
        if ip:
            if not gbl.Gaudi.Utils.hasProperty(ip, name):
                raise AttributeError('property %s does not exist' % name)
            prop = ip.getProperty(name)

            if ROOT6WorkAroundEnabled('ROOT-7201'):
                canSetValue = (hasattr(prop, 'value')
                               and 'const&[' not in prop.value.func_doc
                               and type(value) == type(prop.value()))
            else:
                canSetValue = (hasattr(prop, 'value')
                               and type(value) == type(prop.value()))

            if canSetValue:
                if not prop.setValue(value):
                    raise AttributeError(
                        'property %s could not be set from %s' % (name, value))
            else:
                if tuple == type(value):
                    value = str(value)
                elif hasattr(value, 'toString'):
                    value = value.toString()
                elif not long == type(value):
                    value = '%s' % value
                else:
                    value = '%d' % value
                if ROOT6WorkAroundEnabled('ROOT-6028'):
                    sc = cppyy.gbl.GaudiPython.Helper.setPropertyFromString(
                        prop, value)
                else:
                    sc = prop.fromString(value)
                if sc.isFailure():
                    raise AttributeError(
                        'property %s could not be set from %s' % (name, value))
        else:
            if type(value) == str:
                value = '"%s"' % value  # need double quotes
            elif type(value) == tuple:
                value = str(value)
            elif hasattr(value, 'toString'):
                value = value.toString()
            elif type(value) == long:
                value = '%d' % value  # prevent pending 'L'
            sp = gbl.GaudiPython.Helpers.mkStringProperty(name, str(value))
            self._optsvc.addPropertyToCatalogue(self._name, sp).ignore()

getInterface()

def GaudiPython.Bindings.iProperty.getInterface

(

self

)

Definition at line 255 of file Bindings.py.

    def getInterface(self):
        if not self._ip:
            self.retrieveInterface()
        return self._ip

name()

def GaudiPython.Bindings.iProperty.name

(

self

)

Reimplemented in GaudiPython.Bindings.iAlgTool.

Definition at line 375 of file Bindings.py.

    def name(self):
        return self._name


# ----iService class-----------------------------------------------------------

properties()

def GaudiPython.Bindings.iProperty.properties

(

self

)

Definition at line 355 of file Bindings.py.

    def properties(self):
        dct = {}
        props = None
        ip = self.getInterface()
        if ip:
            props = ip.getProperties()
            propsFrom = self._name  # "interface"
        else:
            props = self._optsvc.getProperties(self._name)
            propsFrom = "jobOptionsSvc"
        if props:
            for p in props:
                try:
                    dct[p.name()] = PropertyEntry(p)
                except (ValueError, TypeError) as e:
                    raise ValueError("gaudimodule.iProperty.properties(): %s%s processing property %s.%s = %s" % \
                        (e.__class__.__name__, e.args,
                         propsFrom, p.name(), p.value()))
        return dct

retrieveInterface()

def GaudiPython.Bindings.iProperty.retrieveInterface

(

self

)

Reimplemented in GaudiPython.Bindings.iAlgTool, GaudiPython.Bindings.iAlgorithm, and GaudiPython.Bindings.iService.

Definition at line 260 of file Bindings.py.

    def retrieveInterface(self):
        pass

---

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

• GaudiPython/python/GaudiPython/Bindings.py