Inheritance diagram for python.TransformConfig.Descriptor:

Collaboration diagram for python.TransformConfig.Descriptor:

Public Types
typedef HLT::TypeInformation::for_each_type_c< typenameEDMLIST::map, my_functor, my_result<>, my_arg< HLT::TypeInformation::get_cont, CONTAINER > >::type	result

Public Member Functions
	__init__ (self, doc, default, allowedValues=None)
	__get__ (self, instance, owner)
	__set__ (self, instance, value)
	name (self)
	default (self)
	doc (self)
	help (self)
	allowedValues (self)

Protected Member Functions
	_attributeName (self, instance)
	_checkType (self, variableName, value)
	_checkValue (self, variableName, value)
	_setValue (self, variableName, value)
	_checkAllowedValues (self, variableName, allowedValues)

Private Attributes
str	__name = '\"%s\"' % doc
	__doc = doc
list	__allowed = []
	__default = default

Detailed Description

Base class for all fixed types, implemented as descriptors. Each instance of a specific fixed type
(a derived class) can be set either to None (to indicate no value has been set), or to a type specified
by the derived class. The type is checked by the derived class by implementing the member function
_checkType()

Definition at line 9 of file TransformConfig.py.

Member Typedef Documentation

◆ result

typedef HLT::TypeInformation::for_each_type_c<typenameEDMLIST::map,my_functor,my_result<>,my_arg<HLT::TypeInformation::get_cont,CONTAINER>>::type master_search< typenameEDMLIST::map, HLT::TypeInformation::get_cont, CONTAINER >::result

inherited

Definition at line 90 of file EDM_MasterSearch.h.

Constructor & Destructor Documentation

◆ init()

python.TransformConfig.Descriptor.__init__	(	self,
		doc,
		default,
		allowedValues = None )

Definition at line 15 of file TransformConfig.py.

    def __init__(self,doc,default,allowedValues=None):
        self.__name = '\"%s\"' % doc  # Temporary name overwritten by JobConfigMetaClass
        self.__doc = doc
        self.__allowed = []
        if allowedValues is not None:
            try:
                allowedValues.__iter__
            except AttributeError:
                allowedValues = [ allowedValues ]
            varName = "%s.allowedValues" % self.__name
            self.__allowed = self._checkAllowedValues( varName, allowedValues )
        # allow None as a value for all types
        if default is not None:
            # check type and value of default
            varName = "%s default" % self.__name
            default = self._checkType( varName, default )
            default = self._checkValue( varName, default )
        self.__default = default
 

Member Function Documentation

◆ get()

python.TransformConfig.Descriptor.__get__	(	self,
		instance,
		owner )

Definition at line 34 of file TransformConfig.py.

    def __get__(self,instance,owner):
        if instance is None:
            return self
        return instance._attributeDictionary().get(self._attributeName(instance),self.__default)
 
 

◆ set()

python.TransformConfig.Descriptor.__set__	(	self,
		instance,
		value )

Definition at line 40 of file TransformConfig.py.

    def __set__(self,instance,value):
        varName = "%s.%s" % (instance.name(), self.__name) # for error/debug printout
        # allow None as a value for all types
        if value is not None:
            # do value and/or type checking and possibly change type and/or value
            value = self._checkType(varName,value)
            value = self._checkValue(varName,value)
        # Do possible additional actions
        self._setValue(varName,value)
        instance._attributeDictionary()[self._attributeName(instance)] = value  # store the value
 
 

◆ _attributeName()

python.TransformConfig.Descriptor._attributeName	(		self,
			instance )

protected

Definition at line 52 of file TransformConfig.py.

    def _attributeName(self,instance):
        return '_%s__%s' % (instance.__class__.__name__,self.__name)

◆ _checkAllowedValues()

python.TransformConfig.Descriptor._checkAllowedValues	(	self,
		variableName,
		allowedValues )

protected

Reimplemented in python.TransformConfig.UniqueList.

Definition at line 121 of file TransformConfig.py.

    def _checkAllowedValues(self,variableName,allowedValues):
        # Check all allowed values
        for v in allowedValues:
            self._checkType(variableName,v)
        return allowedValues
 
        
 

◆ _checkType()

python.TransformConfig.Descriptor._checkType	(	self,
		variableName,
		value )

protected

Private helper functin to check the type of <value>. May convert to another type.
This implementation does nothing, it just returns value.
This function can be overridden in derived class to do type checking.
It should return the value (possible with new type), or raise a TransformConfigError
exception in case of problems.

Reimplemented in python.TransformConfig.ListOfStrings, and python.TransformConfig.UniqueList.

Definition at line 82 of file TransformConfig.py.

    def _checkType(self,variableName,value):
        """Private helper functin to check the type of <value>. May convert to another type.
        This implementation does nothing, it just returns value.
        This function can be overridden in derived class to do type checking.
        It should return the value (possible with new type), or raise a TransformConfigError
        exception in case of problems. """
        return value
 
 

◆ _checkValue()

python.TransformConfig.Descriptor._checkValue	(	self,
		variableName,
		value )

protected

Private helper function to check the value of <value>. This function is
called after calling _checkType. <value> can therefore be considered to be
of the correct type.
This implementation checks that the value is one of the allowed values (if defined).
This function can be overridden in derived class to do type & additional value checking.
It has to return the value (adapted if needed) if all is OK. It has to raise
a TransformConfigError exception in case of problems.
<variableName> is the name of the variable that is being set and is typically
only used for error messages.

Reimplemented in python.TransformConfig.Float, python.TransformConfig.Integer, python.TransformConfig.String, and python.TransformConfig.UniqueList.

Definition at line 91 of file TransformConfig.py.

    def _checkValue(self,variableName,value):
        """Private helper function to check the value of <value>. This function is
        called after calling _checkType. <value> can therefore be considered to be
        of the correct type.
        This implementation checks that the value is one of the allowed values (if defined).
        This function can be overridden in derived class to do type & additional value checking.
        It has to return the value (adapted if needed) if all is OK. It has to raise
        a TransformConfigError exception in case of problems.
        <variableName> is the name of the variable that is being set and is typically
        only used for error messages."""
        if self.__allowed and value not in self.__allowed:
            raise TransformConfigError( '%s value %r is not in %s' %
                                        (variableName, value, self.__allowed) )
 
        return value
 
 

◆ _setValue()

python.TransformConfig.Descriptor._setValue	(	self,
		variableName,
		value )

protected

Private helper function which is called when the value of the object is set.
It is called after _checkType() and _checkValue(), so the value can be
assumed to be correct.
This function can be overridden in a derived class, typically to trigger additional action
when the value is set.
In case of error, raise a TransformConfigError exception, otherwise just return.
This implementation does nothing.
<variableName> is the name of the variable that is being set and is typically
only used for error messages.

Definition at line 108 of file TransformConfig.py.

    def _setValue(self,variableName,value):
        """Private helper function which is called when the value of the object is set.
        It is called after _checkType() and _checkValue(), so the value can be
        assumed to be correct.
        This function can be overridden in a derived class, typically to trigger additional action
        when the value is set.
        In case of error, raise a TransformConfigError exception, otherwise just return.
        This implementation does nothing.
        <variableName> is the name of the variable that is being set and is typically
        only used for error messages."""
        pass
 
 

◆ allowedValues()

python.TransformConfig.Descriptor.allowedValues ( self )

Definition at line 78 of file TransformConfig.py.

    def allowedValues(self):
        return self.__allowed

◆ default()

python.TransformConfig.Descriptor.default ( self )

Definition at line 60 of file TransformConfig.py.

    def default(self):
        return self.__default

◆ doc()

python.TransformConfig.Descriptor.doc ( self )

The documentation string

Definition at line 64 of file TransformConfig.py.

    def doc(self):
        """The documentation string"""
        return self.__doc
    
 

◆ help()

python.TransformConfig.Descriptor.help ( self )

The help string: type, documentation and possible values

Definition at line 69 of file TransformConfig.py.

    def help(self):
        """The help string: type, documentation and possible values"""
        hlp = '(%s) %s' % (self.__class__.__name__, self.__doc)
        if self.__allowed:
            hlp += '. Possible values: %s' % self.__allowed
            
        return hlp
 
 

◆ name()

python.TransformConfig.Descriptor.name ( self )

Definition at line 56 of file TransformConfig.py.

    def name(self):
        return self.__name

Member Data Documentation

◆ __allowed

python.TransformConfig.Descriptor.__allowed = []

private

Definition at line 18 of file TransformConfig.py.

◆ __default

python.TransformConfig.Descriptor.__default = default

private

Definition at line 32 of file TransformConfig.py.

◆ __doc

python.TransformConfig.Descriptor.__doc = doc

private

Definition at line 17 of file TransformConfig.py.

◆ __name

python.TransformConfig.Descriptor.__name = '\"%s\"' % doc

private

Definition at line 16 of file TransformConfig.py.

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

TransformConfig.py

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ result

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __get__()

◆ __set__()

◆ _attributeName()

◆ _checkAllowedValues()

◆ _checkType()

◆ _checkValue()

◆ _setValue()

◆ allowedValues()

◆ default()

◆ doc()

◆ help()

◆ name()

Member Data Documentation

◆ __allowed

◆ __default

◆ __doc

◆ __name

◆ init()

◆ get()

◆ set()