ATLAS Offline Software
Public Member Functions | Private Member Functions | Private Attributes | List of all members
python.TransformConfig.Float Class Reference
Inheritance diagram for python.TransformConfig.Float:
Collaboration diagram for python.TransformConfig.Float:

Public Member Functions

def __init__ (self, doc, default, allowedValues=None)
 
def __get__ (self, instance, owner)
 
def __set__ (self, instance, value)
 
def name (self)
 
def default (self)
 
def doc (self)
 
def help (self)
 
def allowedValues (self)
 

Private Member Functions

def _checkValue (self, variableName, value)
 
def _attributeName (self, instance)
 
def _checkType (self, variableName, value)
 
def _setValue (self, variableName, value)
 
def _checkAllowedValues (self, variableName, allowedValues)
 

Private Attributes

 __name
 
 __doc
 
 __allowed
 
 __default
 

Detailed Description

Definition at line 150 of file TransformConfig.py.

Constructor & Destructor Documentation

◆ __init__()

def python.TransformConfig.Float.__init__ (   self,
  doc,
  default,
  allowedValues = None 
)

Reimplemented from python.TransformConfig.Descriptor.

Definition at line 151 of file TransformConfig.py.

151  def __init__(self,doc,default,allowedValues=None):
152  Descriptor.__init__(self,doc,default,allowedValues)
153 
154 

Member Function Documentation

◆ __get__()

def python.TransformConfig.Descriptor.__get__ (   self,
  instance,
  owner 
)
inherited

Definition at line 34 of file TransformConfig.py.

34  def __get__(self,instance,owner):
35  if instance is None:
36  return self
37  return instance._attributeDictionary().get(self._attributeName(instance),self.__default)
38 
39 

◆ __set__()

def python.TransformConfig.Descriptor.__set__ (   self,
  instance,
  value 
)
inherited

Definition at line 40 of file TransformConfig.py.

40  def __set__(self,instance,value):
41  varName = "%s.%s" % (instance.name(), self.__name) # for error/debug printout
42  # allow None as a value for all types
43  if value is not None:
44  # do value and/or type checking and possibly change type and/or value
45  value = self._checkType(varName,value)
46  value = self._checkValue(varName,value)
47  # Do possible additional actions
48  self._setValue(varName,value)
49  instance._attributeDictionary()[self._attributeName(instance)] = value # store the value
50 
51 

◆ _attributeName()

def python.TransformConfig.Descriptor._attributeName (   self,
  instance 
)
privateinherited

Definition at line 52 of file TransformConfig.py.

52  def _attributeName(self,instance):
53  return '_%s__%s' % (instance.__class__.__name__,self.__name)
54 
55 

◆ _checkAllowedValues()

def python.TransformConfig.Descriptor._checkAllowedValues (   self,
  variableName,
  allowedValues 
)
privateinherited

Reimplemented in python.TransformConfig.UniqueList.

Definition at line 121 of file TransformConfig.py.

121  def _checkAllowedValues(self,variableName,allowedValues):
122  # Check all allowed values
123  for v in allowedValues:
124  self._checkType(variableName,v)
125  return allowedValues
126 
127 
128 

◆ _checkType()

def python.TransformConfig.Descriptor._checkType (   self,
  variableName,
  value 
)
privateinherited
Private helper functin to check the type of <value>. May convert to another type.
This implementation does nothing, it just returns value.
This function can be overridden in derived class to do type checking.
It should return the value (possible with new type), or raise a TransformConfigError
exception in case of problems. 

Reimplemented in python.TransformConfig.ListOfStrings, and python.TransformConfig.UniqueList.

Definition at line 82 of file TransformConfig.py.

82  def _checkType(self,variableName,value):
83  """Private helper functin to check the type of <value>. May convert to another type.
84  This implementation does nothing, it just returns value.
85  This function can be overridden in derived class to do type checking.
86  It should return the value (possible with new type), or raise a TransformConfigError
87  exception in case of problems. """
88  return value
89 
90 

◆ _checkValue()

def python.TransformConfig.Float._checkValue (   self,
  variableName,
  value 
)
private
Private helper function to check the value of <value>. This function is
called after calling _checkType. <value> can therefore be considered to be
of the correct type.
This implementation checks that the value is one of the allowed values (if defined).
This function can be overridden in derived class to do type & additional value checking.
It has to return the value (adapted if needed) if all is OK. It has to raise
a TransformConfigError exception in case of problems.
<variableName> is the name of the variable that is being set and is typically
only used for error messages.

Reimplemented from python.TransformConfig.Descriptor.

Definition at line 155 of file TransformConfig.py.

155  def _checkValue(self,variableName,value):
156  try:
157  value = float(value)
158  except Exception:
159  raise TransformConfigError( '%s value %s is not a float' % (variableName, value) )
160 
161  # check the value against list of possible values
162  return Descriptor._checkValue(self,variableName,value)
163 
164 
165 

◆ _setValue()

def python.TransformConfig.Descriptor._setValue (   self,
  variableName,
  value 
)
privateinherited
Private helper function which is called when the value of the object is set.
It is called after _checkType() and _checkValue(), so the value can be
assumed to be correct.
This function can be overridden in a derived class, typically to trigger additional action
when the value is set.
In case of error, raise a TransformConfigError exception, otherwise just return.
This implementation does nothing.
<variableName> is the name of the variable that is being set and is typically
only used for error messages.

Definition at line 108 of file TransformConfig.py.

108  def _setValue(self,variableName,value):
109  """Private helper function which is called when the value of the object is set.
110  It is called after _checkType() and _checkValue(), so the value can be
111  assumed to be correct.
112  This function can be overridden in a derived class, typically to trigger additional action
113  when the value is set.
114  In case of error, raise a TransformConfigError exception, otherwise just return.
115  This implementation does nothing.
116  <variableName> is the name of the variable that is being set and is typically
117  only used for error messages."""
118  pass
119 
120 

◆ allowedValues()

def python.TransformConfig.Descriptor.allowedValues (   self)
inherited

Definition at line 78 of file TransformConfig.py.

78  def allowedValues(self):
79  return self.__allowed
80 
81 

◆ default()

def python.TransformConfig.Descriptor.default (   self)
inherited

Definition at line 60 of file TransformConfig.py.

60  def default(self):
61  return self.__default
62 
63 

◆ doc()

def python.TransformConfig.Descriptor.doc (   self)
inherited
The documentation string

Definition at line 64 of file TransformConfig.py.

64  def doc(self):
65  """The documentation string"""
66  return self.__doc
67 
68 

◆ help()

def python.TransformConfig.Descriptor.help (   self)
inherited
The help string: type, documentation and possible values

Definition at line 69 of file TransformConfig.py.

69  def help(self):
70  """The help string: type, documentation and possible values"""
71  hlp = '(%s) %s' % (self.__class__.__name__, self.__doc)
72  if self.__allowed:
73  hlp += '. Possible values: %s' % self.__allowed
74 
75  return hlp
76 
77 

◆ name()

def python.TransformConfig.Descriptor.name (   self)
inherited

Definition at line 56 of file TransformConfig.py.

56  def name(self):
57  return self.__name
58 
59 

Member Data Documentation

◆ __allowed

python.TransformConfig.Descriptor.__allowed
privateinherited

Definition at line 18 of file TransformConfig.py.

◆ __default

python.TransformConfig.Descriptor.__default
privateinherited

Definition at line 32 of file TransformConfig.py.

◆ __doc

python.TransformConfig.Descriptor.__doc
privateinherited

Definition at line 17 of file TransformConfig.py.

◆ __name

python.TransformConfig.Descriptor.__name
privateinherited

Definition at line 16 of file TransformConfig.py.


The documentation for this class was generated from the following file:
python.processes.powheg.ZZj_MiNNLO.ZZj_MiNNLO.__init__
def __init__(self, base_directory, **kwargs)
Constructor: all process options are set here.
Definition: ZZj_MiNNLO.py:18
merge_scale_histograms.doc
string doc
Definition: merge_scale_histograms.py:9
python.CaloAddPedShiftConfig.help
help
Definition: CaloAddPedShiftConfig.py:42
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:240
python.CaloAddPedShiftConfig.default
default
Definition: CaloAddPedShiftConfig.py:43
get
T * get(TKey *tobj)
get a TObject* from a TKey* (why can't a TObject be a TKey?)
Definition: hcg.cxx:127
python.LArMinBiasAlgConfig.float
float
Definition: LArMinBiasAlgConfig.py:65