The Gaudi Framework  master (37c0b60a)
GaudiConfig2.semantics.MappingSemantics Class Reference
Inheritance diagram for GaudiConfig2.semantics.MappingSemantics:
Collaboration diagram for GaudiConfig2.semantics.MappingSemantics:

Public Member Functions

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

Public Attributes

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

Private Attributes

 _name
 

Static Private Attributes

 __handled_types__
 

Detailed Description

Definition at line 588 of file semantics.py.

Constructor & Destructor Documentation

◆ __init__()

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

Reimplemented from GaudiConfig2.semantics.PropertySemantics.

Definition at line 591 of file semantics.py.

591  def __init__(self, cpp_type):
592  super(MappingSemantics, self).__init__(cpp_type)
593  template_args = list(extract_template_args(cpp_type))
594  self.key_semantics = getSemanticsFor(template_args[0])
595  self.value_semantics = getSemanticsFor(template_args[1])
596 

Member Function Documentation

◆ default()

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

Definition at line 613 of file semantics.py.

613  def default(self, value):
614  new_value = _DictHelper(self.key_semantics, self.value_semantics)
615  new_value.default = value
616  return new_value
617 

◆ name() [1/2]

def GaudiConfig2.semantics.MappingSemantics.name (   self)

Reimplemented from GaudiConfig2.semantics.PropertySemantics.

Definition at line 598 of file semantics.py.

598  def name(self):
599  return self._name
600 

◆ name() [2/2]

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

Reimplemented from GaudiConfig2.semantics.PropertySemantics.

Definition at line 602 of file semantics.py.

602  def name(self, value):
603  self._name = value
604  self.key_semantics.name = "{} key".format(self._name)
605  self.value_semantics.name = "{} value".format(self._name)
606 

◆ opt_value()

def GaudiConfig2.semantics.MappingSemantics.opt_value (   self,
  value 
)
Option string version of value.

Reimplemented from GaudiConfig2.semantics.PropertySemantics.

Definition at line 618 of file semantics.py.

618  def opt_value(self, value):
619  """
620  Option string version of value.
621  """
622  if not isinstance(value, _DictHelper):
623  value = self.default(value)
624  return value.opt_value()
625 
626 

◆ store()

def GaudiConfig2.semantics.MappingSemantics.store (   self,
  value 
)
Validation/transformation of the data to be stored.

Reimplemented from GaudiConfig2.semantics.PropertySemantics.

Definition at line 607 of file semantics.py.

607  def store(self, value):
608  # No explicit type checking as anything else than dict fails in update call
609  new_value = _DictHelper(self.key_semantics, self.value_semantics)
610  new_value.update(value)
611  return new_value
612 

Member Data Documentation

◆ __handled_types__

GaudiConfig2.semantics.MappingSemantics.__handled_types__
staticprivate

Definition at line 589 of file semantics.py.

◆ _name

GaudiConfig2.semantics.MappingSemantics._name
private

Definition at line 603 of file semantics.py.

◆ key_semantics

GaudiConfig2.semantics.MappingSemantics.key_semantics

Definition at line 594 of file semantics.py.

◆ value_semantics

GaudiConfig2.semantics.MappingSemantics.value_semantics

Definition at line 595 of file semantics.py.


The documentation for this class was generated from the following file:
GaudiConfig2.semantics.getSemanticsFor
def getSemanticsFor(cpp_type)
Definition: semantics.py:636
GaudiConfig2.semantics.extract_template_args
def extract_template_args(cpp_type)
Definition: semantics.py:268
gaudirun.default
default
Definition: gaudirun.py:188
format
GAUDI_API std::string format(const char *,...)
MsgStream format utility "a la sprintf(...)".
Definition: MsgStream.cpp:119
ConditionsStallTest.name
name
Definition: ConditionsStallTest.py:77