GaudiConfig2.semantics.SetSemantics Class Reference

Inheritance diagram for GaudiConfig2.semantics.SetSemantics:

Collaboration diagram for GaudiConfig2.semantics.SetSemantics:

Public Member Functions
	__init__ (self, cpp_type, valueSem=None)
	name (self)
	name (self, value)
	store (self, value)
	default (self, value)
	opt_value (self, value)
	merge (self, bb, aa)
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
	value_semantics
Public Attributes inherited from GaudiConfig2.semantics.PropertySemantics
	cpp_type = cpp_type

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

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

Detailed Description

Merge semantics for (unordered) sets.

Definition at line 648 of file semantics.py.

Constructor & Destructor Documentation

__init__()

GaudiConfig2.semantics.SetSemantics.__init__	(		self,
			cpp_type,
			valueSem = None )

Definition at line 653 of file semantics.py.

    def __init__(self, cpp_type, valueSem=None):
        super().__init__(cpp_type)
        self.value_semantics = valueSem or getSemanticsFor(
            list(extract_template_args(cpp_type))[0]
        )
 

Member Function Documentation

default()

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

Definition at line 677 of file semantics.py.

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

merge()

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

"Merge" two values.

Used when merging two Configurable instances, by default just ensure
the two values do not conflict, but it can be overridden in
derived semantics to, for example, append to the two lists.

Reimplemented from GaudiConfig2.semantics.PropertySemantics.

Definition at line 690 of file semantics.py.

    def merge(self, bb, aa):
        aa |= bb
        return aa
 
 

name() [1/2]

GaudiConfig2.semantics.SetSemantics.name

(

self

)

Reimplemented from GaudiConfig2.semantics.PropertySemantics.

Definition at line 660 of file semantics.py.

    def name(self):
        return self._name
 

name() [2/2]

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

Reimplemented from GaudiConfig2.semantics.PropertySemantics.

Definition at line 664 of file semantics.py.

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

opt_value()

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

Option string version of value.

Reimplemented from GaudiConfig2.semantics.PropertySemantics.

Definition at line 682 of file semantics.py.

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

store()

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

Validation/transformation of the data to be stored.

Reimplemented from GaudiConfig2.semantics.PropertySemantics.

Definition at line 668 of file semantics.py.

    def store(self, value):
        # We support assignment from list for backwards compatibility
        if not isinstance(value, (set, _SetHelper, list, _ListHelper)):
            raise TypeError(f"set expected, got {value!r} in assignment to {self.name}")
 
        new_value = _SetHelper(self.value_semantics)
        new_value |= value
        return new_value
 

Member Data Documentation

__handled_types__

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

staticprivate

Definition at line 651 of file semantics.py.

value_semantics

GaudiConfig2.semantics.SetSemantics.value_semantics

Initial value:

=  valueSem or getSemanticsFor(
            list(extract_template_args(cpp_type))[0]
        )

Definition at line 655 of file semantics.py.

---

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

• GaudiConfiguration/python/GaudiConfig2/semantics.py