Inheritance diagram for GaudiConfig2.semantics.PropertySemantics:

Collaboration diagram for GaudiConfig2.semantics.PropertySemantics:

Public Member Functions
	__init__ (self, cpp_type)
	name (self)
	name (self, value)
	cpp_type (self)
	cpp_type (self, value)
	load (self, value)
	store (self, value)
	is_set (self, value)
	opt_value (self, value)
	merge (self, a, b)

Public Attributes
	cpp_type = cpp_type

Protected Attributes
	_name = None
	_cpp_type = value

Static Private Attributes
tuple	__handled_types__ = ()

Detailed Description

Basic property semantics implementation, with no validation/transformation.

Not to be used directly for any actual property, use only specializations.

Definition at line 28 of file semantics.py.

Constructor & Destructor Documentation

◆ init()

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

Definition at line 37 of file semantics.py.

    def __init__(self, cpp_type):
        self._name = None
        self.cpp_type = cpp_type
 

Member Function Documentation

◆ cpp_type() [1/2]

GaudiConfig2.semantics.PropertySemantics.cpp_type ( self )

Definition at line 50 of file semantics.py.

    def cpp_type(self):
        return self._cpp_type
 

◆ cpp_type() [2/2]

GaudiConfig2.semantics.PropertySemantics.cpp_type	(		self,
			value )

Definition at line 54 of file semantics.py.

    def cpp_type(self, value):
        if not any(
            h.match(value) if hasattr(h, "match") else h == value
            for h in self.__handled_types__
        ):
            raise TypeError("C++ type {!r} not supported".format(value))
        self._cpp_type = value
 

◆ is_set()

GaudiConfig2.semantics.PropertySemantics.is_set	(		self,
			value )

Allow overriding the definition of "is set" if we need helper types.

Reimplemented in GaudiConfig2.semantics.DefaultSemantics, and GaudiConfig2.semantics.JSONSemantics.

Definition at line 74 of file semantics.py.

    def is_set(self, value):
        """
        Allow overriding the definition of "is set" if we need helper types.
        """
        return True
 

◆ load()

GaudiConfig2.semantics.PropertySemantics.load	(		self,
			value )

Transformation for data when reading the property.

Reimplemented in GaudiConfig2.semantics.JSONSemantics.

Definition at line 62 of file semantics.py.

    def load(self, value):
        """
        Transformation for data when reading the property.
        """
        return value
 

◆ merge()

GaudiConfig2.semantics.PropertySemantics.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 in GaudiConfig2.semantics.ComponentHandleSemantics, GaudiConfig2.semantics.GaudiHandleArraySemantics, GaudiConfig2.semantics.MappingSemantics, GaudiConfig2.semantics.OrderedSetSemantics, and GaudiConfig2.semantics.SetSemantics.

Definition at line 88 of file semantics.py.

    def 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.
        """
        if self.store(a) != self.store(b):
            raise ValueError("cannot merge values %r and %r" % (a, b))
        return a
 
 

◆ name() [1/2]

GaudiConfig2.semantics.PropertySemantics.name ( self )

Reimplemented in GaudiConfig2.semantics.MappingSemantics, GaudiConfig2.semantics.MappingSemantics, GaudiConfig2.semantics.SequenceSemantics, GaudiConfig2.semantics.SequenceSemantics, GaudiConfig2.semantics.SetSemantics, and GaudiConfig2.semantics.SetSemantics.

Definition at line 42 of file semantics.py.

    def name(self):
        return self._name
 

◆ name() [2/2]

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

Reimplemented in GaudiConfig2.semantics.MappingSemantics, GaudiConfig2.semantics.MappingSemantics, GaudiConfig2.semantics.SequenceSemantics, GaudiConfig2.semantics.SequenceSemantics, GaudiConfig2.semantics.SetSemantics, and GaudiConfig2.semantics.SetSemantics.

Definition at line 46 of file semantics.py.

    def name(self, value):
        self._name = value
 

◆ opt_value()

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

Option string version of value.

Reimplemented in GaudiConfig2.semantics.DataHandleSemantics, GaudiConfig2.semantics.GaudiHandleArraySemantics, GaudiConfig2.semantics.JSONSemantics, GaudiConfig2.semantics.MappingSemantics, GaudiConfig2.semantics.SequenceSemantics, and GaudiConfig2.semantics.SetSemantics.

Definition at line 80 of file semantics.py.

    def opt_value(self, value):
        """
        Option string version of value.
        """
        if hasattr(value, "__opt_value__"):
            return value.__opt_value__()
        return value
 

◆ store()

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

Validation/transformation of the data to be stored.

Definition at line 68 of file semantics.py.

    def store(self, value):
        """
        Validation/transformation of the data to be stored.
        """
        return value
 

Member Data Documentation

◆ __handled_types__

tuple GaudiConfig2.semantics.PropertySemantics.__handled_types__ = ()

staticprivate

Definition at line 35 of file semantics.py.

◆ _cpp_type

GaudiConfig2.semantics.PropertySemantics._cpp_type = value

protected

Definition at line 60 of file semantics.py.

◆ _name

GaudiConfig2.semantics.PropertySemantics._name = None

protected

Definition at line 38 of file semantics.py.

◆ cpp_type

GaudiConfig2.semantics.PropertySemantics.cpp_type = cpp_type

Definition at line 39 of file semantics.py.

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

GaudiConfiguration/python/GaudiConfig2/semantics.py

Public Member Functions

Public Attributes

Protected Attributes

Static Private Attributes