GaudiConfig2.semantics.ComponentHandleSemantics Class Reference

Inheritance diagram for GaudiConfig2.semantics.ComponentHandleSemantics:

Collaboration diagram for GaudiConfig2.semantics.ComponentHandleSemantics:

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

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

Static Private Attributes
	__handled_types__

Detailed Description

Semantics for component (tool, service) handles. On access, it will create the
corresponding Configurable instance and store it in the property.

Definition at line 271 of file semantics.py.

Constructor & Destructor Documentation

__init__()

def GaudiConfig2.semantics.ComponentHandleSemantics.__init__	(		self,
			cpp_type
	)

Reimplemented from GaudiConfig2.semantics.PropertySemantics.

Definition at line 279 of file semantics.py.

    def __init__(self, cpp_type):
        super().__init__(cpp_type)
        self.handle_type = getattr(GaudiKernel.GaudiHandles, self.cpp_type)
 

Member Function Documentation

default()

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

Definition at line 311 of file semantics.py.

    def default(self, value):
        return self.store(value)
 

merge()

def GaudiConfig2.semantics.ComponentHandleSemantics.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 314 of file semantics.py.

    def merge(self, b, a):
        return a.merge(b)
 
 

store()

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

Validation/transformation of the data to be stored.

Reimplemented from GaudiConfig2.semantics.PropertySemantics.

Definition at line 283 of file semantics.py.

    def store(self, value):
        # Configurable: store if correct type
        if (
            isinstance(value, Configurable)
            and value.getGaudiType() == self.handle_type.componentType
        ):
            return value
 
        # Handle: create Configurable
        elif isinstance(value, GaudiHandle):
            return (
                Configurables.getByType(value.getType()).getInstance(value.getName())
                if value.typeAndName
                else self.handle_type()  # empty handle
            )
 
        # Empty: empty Handle
        elif value is None or value == "":
            return self.handle_type()
 
        # String: create Configurable
        elif isinstance(value, str):
            tn = value.split("/", maxsplit=1)  # type[/name]
            name = tn[1] if len(tn) == 2 else tn[0]
            return Configurables.getByType(tn[0]).getInstance(name)
 
        raise TypeError(f"cannot assign {value!r} ({type(value)}) to {self.name}")
 

Member Data Documentation

__handled_types__

GaudiConfig2.semantics.ComponentHandleSemantics.__handled_types__

staticprivate

Definition at line 277 of file semantics.py.

handle_type

GaudiConfig2.semantics.ComponentHandleSemantics.handle_type

Definition at line 281 of file semantics.py.

---

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

• GaudiConfiguration/python/GaudiConfig2/semantics.py