GaudiConfig2.semantics.SetSemantics Class Reference

Inheritance diagram for GaudiConfig2.semantics.SetSemantics:

Collaboration diagram for GaudiConfig2.semantics.SetSemantics:

Public Member Functions
def	__init__ (self, cpp_type, valueSem=None)
def	name (self)
def	name (self, value)
def	store (self, value)
def	default (self, value)
def	opt_value (self, value)
def	merge (self, bb, aa)
Public Member Functions inherited from GaudiConfig2.semantics.PropertySemantics
def	__init__ (self, cpp_type)
def	cpp_type (self)
def	cpp_type (self, value)
def	load (self, value)
def	is_set (self, value)

Public Attributes
	value_semantics
Public Attributes inherited from GaudiConfig2.semantics.PropertySemantics
	cpp_type

Private Attributes
	_name

Static Private Attributes
	__handled_types__

Detailed Description

Merge semantics for (unordered) sets.

Definition at line 443 of file semantics.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 448 of file semantics.py.

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

Member Function Documentation

default()

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

Definition at line 474 of file semantics.py.

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

merge()

def 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 487 of file semantics.py.

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

name() [1/2]

def GaudiConfig2.semantics.SetSemantics.name

(

self

)

Reimplemented from GaudiConfig2.semantics.PropertySemantics.

Definition at line 455 of file semantics.py.

    def name(self):
        return self._name
 

name() [2/2]

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

Reimplemented from GaudiConfig2.semantics.PropertySemantics.

Definition at line 459 of file semantics.py.

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

opt_value()

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

Option string version of value.

Reimplemented from GaudiConfig2.semantics.PropertySemantics.

Definition at line 479 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()

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

Validation/transformation of the data to be stored.

Reimplemented from GaudiConfig2.semantics.PropertySemantics.

Definition at line 463 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(
                "set expected, got {!r} in assignment to {}".format(value, self.name)
            )
 
        new_value = _SetHelper(self.value_semantics)
        new_value |= value
        return new_value
 

Member Data Documentation

__handled_types__

GaudiConfig2.semantics.SetSemantics.__handled_types__

staticprivate

Definition at line 446 of file semantics.py.

_name

GaudiConfig2.semantics.SetSemantics._name

private

Definition at line 460 of file semantics.py.

value_semantics

GaudiConfig2.semantics.SetSemantics.value_semantics

Definition at line 450 of file semantics.py.

---

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

• GaudiConfiguration/python/GaudiConfig2/semantics.py