GaudiConfig2.semantics.MappingSemantics Class Reference

Inheritance diagram for GaudiConfig2.semantics.MappingSemantics:

Collaboration diagram for GaudiConfig2.semantics.MappingSemantics:

Public Member Functions
	__init__ (self, cpp_type)
	name (self)
	name (self, value)
	store (self, value)
	default (self, value)
	opt_value (self, value)
	merge (self, a, b)
Public Member Functions inherited from GaudiConfig2.semantics.PropertySemantics
	__init__ (self, cpp_type)
	cpp_type (self)
	cpp_type (self, value)
	load (self, value)
	is_set (self, value)

Public Attributes
	key_semantics = getSemanticsFor(template_args[0])
	value_semantics = getSemanticsFor(template_args[1])
Public Attributes inherited from GaudiConfig2.semantics.PropertySemantics
	cpp_type = cpp_type

Static Private Attributes
tuple	__handled_types__ = (re.compile(r"(std::)?(unordered_)?map<.*>$"),)

Additional Inherited Members
Protected Attributes inherited from GaudiConfig2.semantics.PropertySemantics
	_name = None
	_cpp_type = value

Detailed Description

Definition at line 791 of file semantics.py.

Constructor & Destructor Documentation

__init__()

GaudiConfig2.semantics.MappingSemantics.__init__	(		self,
			cpp_type )

Definition at line 794 of file semantics.py.

    def __init__(self, cpp_type):
        super().__init__(cpp_type)
        template_args = list(extract_template_args(cpp_type))
        self.key_semantics = getSemanticsFor(template_args[0])
        self.value_semantics = getSemanticsFor(template_args[1])
 

Member Function Documentation

default()

GaudiConfig2.semantics.MappingSemantics.default	(		self,
			value )

Definition at line 816 of file semantics.py.

    def default(self, value):
        new_value = _DictHelper(self.key_semantics, self.value_semantics)
        new_value.default = value
        return new_value
 

merge()

GaudiConfig2.semantics.MappingSemantics.merge	(		self,
			a,
			b )

Merge two maps. Throw ValueError if there are conflicting key/value pairs.

Reimplemented from GaudiConfig2.semantics.PropertySemantics.

Definition at line 829 of file semantics.py.

    def merge(self, a, b):
        """Merge two maps. Throw ValueError if there are conflicting key/value pairs."""
 
        # Optimization for most common case
        if a == b:
            return a
 
        for k, v in b.items():
            try:
                va = a[k]
            except KeyError:
                a[k] = v
            else:
                if va != v:
                    raise ValueError(
                        f"conflicting values in map for key {k}: {v} and {va}"
                    )
        return a
 
 

name() [1/2]

GaudiConfig2.semantics.MappingSemantics.name

(

self

)

Reimplemented from GaudiConfig2.semantics.PropertySemantics.

Definition at line 801 of file semantics.py.

    def name(self):
        return self._name
 

name() [2/2]

GaudiConfig2.semantics.MappingSemantics.name	(		self,
			value )

Reimplemented from GaudiConfig2.semantics.PropertySemantics.

Definition at line 805 of file semantics.py.

    def name(self, value):
        self._name = value
        self.key_semantics.name = f"{self._name} key"
        self.value_semantics.name = f"{self._name} value"
 

opt_value()

GaudiConfig2.semantics.MappingSemantics.opt_value	(		self,
			value )

Option string version of value.

Reimplemented from GaudiConfig2.semantics.PropertySemantics.

Definition at line 821 of file semantics.py.

    def opt_value(self, value):
        """
        Option string version of value.
        """
        if not isinstance(value, _DictHelper):
            value = self.default(value)
        return value.opt_value()
 

store()

GaudiConfig2.semantics.MappingSemantics.store	(		self,
			value )

Validation/transformation of the data to be stored.

Reimplemented from GaudiConfig2.semantics.PropertySemantics.

Definition at line 810 of file semantics.py.

    def store(self, value):
        # No explicit type checking as anything else than dict fails in update call
        new_value = _DictHelper(self.key_semantics, self.value_semantics)
        new_value.update(value)
        return new_value
 

Member Data Documentation

__handled_types__

tuple GaudiConfig2.semantics.MappingSemantics.__handled_types__ = (re.compile(r"(std::)?(unordered_)?map<.*>$"),)

staticprivate

Definition at line 792 of file semantics.py.

key_semantics

GaudiConfig2.semantics.MappingSemantics.key_semantics = getSemanticsFor(template_args[0])

Definition at line 797 of file semantics.py.

value_semantics

GaudiConfig2.semantics.MappingSemantics.value_semantics = getSemanticsFor(template_args[1])

Definition at line 798 of file semantics.py.

---

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

• GaudiConfiguration/python/GaudiConfig2/semantics.py