GaudiConfig2.semantics.PropertySemantics Class Reference

Inheritance diagram for GaudiConfig2.semantics.PropertySemantics:

Collaboration diagram for GaudiConfig2.semantics.PropertySemantics:

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

Public Attributes
	cpp_type

Private Attributes
	_name
	_cpp_type

Static Private Attributes
	__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 21 of file semantics.py.

Constructor & Destructor Documentation

__init__()

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

Reimplemented in GaudiConfig2.semantics.MappingSemantics, GaudiConfig2.semantics.OrderedSetSemantics, and GaudiConfig2.semantics.ComponentSemantics.

Definition at line 30 of file semantics.py.

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

Member Function Documentation

cpp_type() [1/2]

def GaudiConfig2.semantics.PropertySemantics.cpp_type

(

self

)

Definition at line 43 of file semantics.py.

    def cpp_type(self):
        return self._cpp_type
 

cpp_type() [2/2]

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

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

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

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

Reimplemented in GaudiConfig2.semantics.DefaultSemantics.

Definition at line 67 of file semantics.py.

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

load()

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

Transformation for data when reading the property.

Definition at line 55 of file semantics.py.

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

merge()

def 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.OrderedSetSemantics, and GaudiConfig2.semantics.SetSemantics.

Definition at line 81 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]

def GaudiConfig2.semantics.PropertySemantics.name

(

self

)

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

Definition at line 35 of file semantics.py.

    def name(self):
        return self._name
 

name() [2/2]

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

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

Definition at line 39 of file semantics.py.

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

opt_value()

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

Option string version of value.

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

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

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

Validation/transformation of the data to be stored.

Reimplemented in GaudiConfig2.semantics.MappingSemantics, GaudiConfig2.semantics.SetSemantics, GaudiConfig2.semantics.SequenceSemantics, GaudiConfig2.semantics.ComponentSemantics, GaudiConfig2.semantics.IntSemantics, GaudiConfig2.semantics.FloatSemantics, GaudiConfig2.semantics.BoolSemantics, GaudiConfig2.semantics.StringSemantics, and GaudiConfig2.semantics.DefaultSemantics.

Definition at line 61 of file semantics.py.

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

Member Data Documentation

__handled_types__

GaudiConfig2.semantics.PropertySemantics.__handled_types__

staticprivate

Definition at line 28 of file semantics.py.

_cpp_type

GaudiConfig2.semantics.PropertySemantics._cpp_type

private

Definition at line 53 of file semantics.py.

_name

GaudiConfig2.semantics.PropertySemantics._name

private

Definition at line 31 of file semantics.py.

cpp_type

GaudiConfig2.semantics.PropertySemantics.cpp_type

Definition at line 32 of file semantics.py.

---

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

• GaudiConfiguration/python/GaudiConfig2/semantics.py