GaudiConfig2._configurables.Property Class Reference

Inheritance diagram for GaudiConfig2._configurables.Property:

Collaboration diagram for GaudiConfig2._configurables.Property:

Public Member Functions
	__init__ (self, cpp_type, default, doc="undocumented", semantics=None)
	cpp_type (self)
	name (self)
	__get__ (self, instance, owner)
	__set__ (self, instance, value)
	__delete__ (self, instance)
	__set_name__ (self, owner, name)
	__is_set__ (self, instance, owner)
	__opt_value__ (self, instance, owner)
	__merge__ (self, instance, owner, value)

Public Attributes
	semantics = getSemanticsFor(cpp_type)
	default = default
	name

Private Attributes
	__doc__ = doc

Detailed Description

Descriptor class to implement validation of Configurable properties.

Definition at line 31 of file _configurables.py.

Constructor & Destructor Documentation

__init__()

GaudiConfig2._configurables.Property.__init__	(		self,
			cpp_type,
			default,
			doc = "undocumented",
			semantics = None )

Definition at line 36 of file _configurables.py.

    def __init__(self, cpp_type, default, doc="undocumented", semantics=None):
        from .semantics import getSemanticsFor
 
        if semantics is None:
            self.semantics = getSemanticsFor(cpp_type)
        else:
            self.semantics = getSemanticsFor(semantics, strict=True)
 
        self.default = default
        self.__doc__ = doc
 

Member Function Documentation

__delete__()

GaudiConfig2._configurables.Property.__delete__	(		self,
			instance )

Definition at line 64 of file _configurables.py.

    def __delete__(self, instance):
        del instance._properties[self.name]
 

__get__()

GaudiConfig2._configurables.Property.__get__	(		self,
			instance,
			owner )

Definition at line 55 of file _configurables.py.

    def __get__(self, instance, owner):
        name = self.name  # cache lookup
        if name not in instance._properties and hasattr(self.semantics, "default"):
            instance._properties[name] = self.semantics.default(self.default)
        return self.semantics.load(instance._properties.get(name, self.default))
 

__is_set__()

GaudiConfig2._configurables.Property.__is_set__	(		self,
			instance,
			owner )

Definition at line 70 of file _configurables.py.

    def __is_set__(self, instance, owner):
        try:
            value = instance._properties[self.name]
            return self.semantics.is_set(value)
        except KeyError:
            return False
 

__merge__()

GaudiConfig2._configurables.Property.__merge__	(		self,
			instance,
			owner,
			value )

Return "merge" (according to the semantic) of the value
in this property and the incoming value.

Definition at line 82 of file _configurables.py.

    def __merge__(self, instance, owner, value):
        """
        Return "merge" (according to the semantic) of the value
        in this property and the incoming value.
        """
        if not self.__is_set__(instance, owner):
            return value
        return self.semantics.merge(self.__get__(instance, owner), value)
 
 

__opt_value__()

GaudiConfig2._configurables.Property.__opt_value__	(		self,
			instance,
			owner )

Definition at line 77 of file _configurables.py.

    def __opt_value__(self, instance, owner):
        return self.semantics.opt_value(
            instance._properties.get(self.name, self.default)
        )
 

__set__()

GaudiConfig2._configurables.Property.__set__	(		self,
			instance,
			value )

Definition at line 61 of file _configurables.py.

    def __set__(self, instance, value):
        instance._properties[self.name] = self.semantics.store(value)
 

__set_name__()

GaudiConfig2._configurables.Property.__set_name__	(		self,
			owner,
			name )

Definition at line 67 of file _configurables.py.

    def __set_name__(self, owner, name):
        self.semantics.name = name
 

cpp_type()

GaudiConfig2._configurables.Property.cpp_type

(

self

)

Definition at line 48 of file _configurables.py.

    def cpp_type(self):
        return self.semantics.cpp_type
 

name()

GaudiConfig2._configurables.Property.name

(

self

)

Definition at line 52 of file _configurables.py.

    def name(self):
        return self.semantics.name
 

Member Data Documentation

__doc__

GaudiConfig2._configurables.Property.__doc__ = doc

private

Definition at line 45 of file _configurables.py.

default

GaudiConfig2._configurables.Property.default = default

Definition at line 44 of file _configurables.py.

name

GaudiConfig2._configurables.Property.name

Definition at line 79 of file _configurables.py.

semantics

GaudiConfig2._configurables.Property.semantics = getSemanticsFor(cpp_type)

Definition at line 40 of file _configurables.py.

---

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

• GaudiConfiguration/python/GaudiConfig2/_configurables.py