![]() |
The Gaudi Framework
v27r0
|


Public Member Functions | |
| def | __init__ (self, name=Configurable.DefaultName, _enabled=True, kwargs) |
| def | getGaudiType (self) |
| def | getDlls (self) |
| def | getHandle (self) |
| def | __detach_used__ (self) |
| def | propagateProperty |
| def | propagateProperties |
| def | __apply_configuration__ (self) |
| def | applyConf (self) |
| def | getUsedInstance (self, name) |
| def | isApplicable (self) |
| def | __init__ (self, name=Configurable.DefaultName, _enabled=True, kwargs) |
| def | getGaudiType (self) |
| def | getDlls (self) |
| def | getHandle (self) |
| def | __detach_used__ (self) |
| def | propagateProperty |
| def | propagateProperties |
| def | __apply_configuration__ (self) |
| def | applyConf (self) |
| def | getUsedInstance (self, name) |
| def | isApplicable (self) |
Public Member Functions inherited from GaudiKernel.Configurable.Configurable | |
| def | __new__ (cls, args, kwargs) |
| def | __init__ |
| def | __getstate__ (self) |
| def | __getnewargs__ (self) |
| def | __setstate__ (self, dict) |
| def | __len__ (self) |
| def | __iter__ (self) |
| def | __deepcopy__ (self, memo) |
| def | __iadd__ |
| def | __getattr__ (self, attr) |
| def | __setattr__ (self, name, value) |
| def | __delattr__ (self, attr) |
| def | __nonzero__ (self) |
| def | remove (self, items) |
| def | removeAll (self) |
| def | copyChild (self, child) |
| def | setParent (self, parentName) |
| def | getParent (self) |
| def | hasParent (self, parent) |
| def | copyChildAndSetParent (self, cfg, parent) |
| def | getChildren (self) |
| def | getTools (self) |
| def | children (self) |
| def | getAllChildren (self) |
| def | getSequence (self) |
| def | setup (self) |
| def | getProperties (self) |
| def | getPropertiesWithDescription (self) |
| def | getValuedProperties (self) |
| def | properties (self) |
| def | getDefaultProperties (cls) |
| def | getDefaultProperty (cls, name) |
| def | getProp (self, name) |
| def | setProp (self, name, value) |
| def | isPropertySet (self, name) |
| def | getType (cls) |
| def | getName (self) |
| def | name (self) |
| def | getJobOptName (self) |
| def | isPublic (self) |
| def | jobOptName (self) |
| def | getFullName (self) |
| def | getFullJobOptName (self) |
| def | getPrintTitle (self) |
| def | getTitleName (self) |
| def | setDefaults (cls, handle) |
| def | clone (self, name=None, kwargs) |
| def | splitName (self) |
| def | addTool |
| def | __repr__ (self) |
| def | __str__ |
| def | __new__ (cls, args, kwargs) |
| def | __init__ |
| def | __getstate__ (self) |
| def | __getnewargs__ (self) |
| def | __setstate__ (self, dict) |
| def | __len__ (self) |
| def | __iter__ (self) |
| def | __deepcopy__ (self, memo) |
| def | __iadd__ |
| def | __getattr__ (self, attr) |
| def | __setattr__ (self, name, value) |
| def | __delattr__ (self, attr) |
| def | __nonzero__ (self) |
| def | remove (self, items) |
| def | removeAll (self) |
| def | copyChild (self, child) |
| def | setParent (self, parentName) |
| def | getParent (self) |
| def | hasParent (self, parent) |
| def | copyChildAndSetParent (self, cfg, parent) |
| def | getChildren (self) |
| def | getTools (self) |
| def | children (self) |
| def | getAllChildren (self) |
| def | getSequence (self) |
| def | setup (self) |
| def | getProperties (self) |
| def | getPropertiesWithDescription (self) |
| def | getValuedProperties (self) |
| def | properties (self) |
| def | getDefaultProperties (cls) |
| def | getDefaultProperty (cls, name) |
| def | getProp (self, name) |
| def | setProp (self, name, value) |
| def | isPropertySet (self, name) |
| def | getType (cls) |
| def | getName (self) |
| def | name (self) |
| def | getJobOptName (self) |
| def | isPublic (self) |
| def | jobOptName (self) |
| def | getFullName (self) |
| def | getFullJobOptName (self) |
| def | getPrintTitle (self) |
| def | getTitleName (self) |
| def | setDefaults (cls, handle) |
| def | clone (self, name=None, kwargs) |
| def | splitName (self) |
| def | addTool |
| def | __repr__ (self) |
| def | __str__ |
Private Member Functions | |
| def | __addActiveUseOf (self, other) |
| def | __addPassiveUseOf (self, other) |
| def | _instanceName (self, cls) |
| def | __addActiveUseOf (self, other) |
| def | __addPassiveUseOf (self, other) |
| def | _instanceName (self, cls) |
Private Attributes | |
| _enabled | |
| __users__ | |
| _applied | |
| __used_instances__ | |
Static Private Attributes | |
| dictionary | __slots__ |
| list | __used_configurables__ = [] |
| list of ConfigurableUser classes this one is going to modify in the apply_configuration method. More... | |
| list | __queried_configurables__ = [] |
| list of ConfigurableUser classes this one is going to query in the apply_configuration method More... | |
Additional Inherited Members | |
Static Public Attributes inherited from GaudiKernel.Configurable.Configurable | |
| string | indentUnit = '| ' |
| int | printHeaderWidth = 100 |
| int | printHeaderPre = 5 |
| dictionary | allConfigurables = {} |
| dictionary | configurableServices = {} |
Definition at line 1136 of file Configurable.py.
| def GaudiKernel.Configurable.ConfigurableUser.__init__ | ( | self, | |
name = Configurable.DefaultName, |
|||
_enabled = True, |
|||
| kwargs | |||
| ) |
Definition at line 1153 of file Configurable.py.
| def GaudiKernel.Configurable.ConfigurableUser.__init__ | ( | self, | |
name = Configurable.DefaultName, |
|||
_enabled = True, |
|||
| kwargs | |||
| ) |
Definition at line 1153 of file Configurable.py.
|
private |
Declare that we are going to modify the Configurable 'other' in our __apply_configuration__.
Definition at line 1199 of file Configurable.py.
|
private |
Declare that we are going to modify the Configurable 'other' in our __apply_configuration__.
Definition at line 1199 of file Configurable.py.
|
private |
Declare that we are going to retrieve property values from the ConfigurableUser 'other' in our __apply_configuration__.
Definition at line 1207 of file Configurable.py.
|
private |
Declare that we are going to retrieve property values from the ConfigurableUser 'other' in our __apply_configuration__.
Definition at line 1207 of file Configurable.py.
| def GaudiKernel.Configurable.ConfigurableUser.__apply_configuration__ | ( | self | ) |
Function to be overridden to convert the high level configuration into a low level one. The default implementation calls applyConf, which is the method defined in some ConfigurableUser implementations.
Definition at line 1291 of file Configurable.py.
| def GaudiKernel.Configurable.ConfigurableUser.__apply_configuration__ | ( | self | ) |
Function to be overridden to convert the high level configuration into a low level one. The default implementation calls applyConf, which is the method defined in some ConfigurableUser implementations.
Definition at line 1291 of file Configurable.py.
| def GaudiKernel.Configurable.ConfigurableUser.__detach_used__ | ( | self | ) |
Remove this ConfigurableUser instance from the users list of the used instances.
Definition at line 1222 of file Configurable.py.
| def GaudiKernel.Configurable.ConfigurableUser.__detach_used__ | ( | self | ) |
Remove this ConfigurableUser instance from the users list of the used instances.
Definition at line 1222 of file Configurable.py.
|
private |
Function used to define the name of the private instance of a given class name. This method is used when the __used_configurables_property__ declares the need of a private used configurable without specifying the name.
Definition at line 1307 of file Configurable.py.
|
private |
Function used to define the name of the private instance of a given class name. This method is used when the __used_configurables_property__ declares the need of a private used configurable without specifying the name.
Definition at line 1307 of file Configurable.py.
| def GaudiKernel.Configurable.ConfigurableUser.applyConf | ( | self | ) |
Function to be overridden to convert the high level configuration into a low level one.
Definition at line 1300 of file Configurable.py.
| def GaudiKernel.Configurable.ConfigurableUser.applyConf | ( | self | ) |
Function to be overridden to convert the high level configuration into a low level one.
Definition at line 1300 of file Configurable.py.
| def GaudiKernel.Configurable.ConfigurableUser.getDlls | ( | self | ) |
Definition at line 1217 of file Configurable.py.
| def GaudiKernel.Configurable.ConfigurableUser.getDlls | ( | self | ) |
Definition at line 1217 of file Configurable.py.
| def GaudiKernel.Configurable.ConfigurableUser.getGaudiType | ( | self | ) |
Definition at line 1215 of file Configurable.py.
| def GaudiKernel.Configurable.ConfigurableUser.getGaudiType | ( | self | ) |
Definition at line 1215 of file Configurable.py.
| def GaudiKernel.Configurable.ConfigurableUser.getHandle | ( | self | ) |
Definition at line 1219 of file Configurable.py.
| def GaudiKernel.Configurable.ConfigurableUser.getHandle | ( | self | ) |
Definition at line 1219 of file Configurable.py.
| def GaudiKernel.Configurable.ConfigurableUser.getUsedInstance | ( | self, | |
| name | |||
| ) |
Return the used instance with a given name.
Definition at line 1320 of file Configurable.py.
| def GaudiKernel.Configurable.ConfigurableUser.getUsedInstance | ( | self, | |
| name | |||
| ) |
Return the used instance with a given name.
Definition at line 1320 of file Configurable.py.
| def GaudiKernel.Configurable.ConfigurableUser.isApplicable | ( | self | ) |
Return True is the instance can be "applied".
Definition at line 1333 of file Configurable.py.
| def GaudiKernel.Configurable.ConfigurableUser.isApplicable | ( | self | ) |
Return True is the instance can be "applied".
Definition at line 1333 of file Configurable.py.
| def GaudiKernel.Configurable.ConfigurableUser.propagateProperties | ( | self, | |
names = None, |
|||
others = None, |
|||
force = True |
|||
| ) |
Call propagateProperty for each property listed in 'names'. If 'names' is None, all the properties are propagated.
Definition at line 1280 of file Configurable.py.
| def GaudiKernel.Configurable.ConfigurableUser.propagateProperties | ( | self, | |
names = None, |
|||
others = None, |
|||
force = True |
|||
| ) |
Call propagateProperty for each property listed in 'names'. If 'names' is None, all the properties are propagated.
Definition at line 1280 of file Configurable.py.
| def GaudiKernel.Configurable.ConfigurableUser.propagateProperty | ( | self, | |
| name, | |||
others = None, |
|||
force = True |
|||
| ) |
Propagate the property 'name' (if set) to other configurables (if possible).
'others' can be:
None:
propagate to all the entries in __used_configurables__
a configurable instance:
propagate only to it
list of configurable instances:
propagate to all of them.
The logic is:
- if the local property is set, the other property will be overwritten
- local property not set and other set => keep other
- local property not set and other not set => overwrite the default for
ConfigurableUser instances and set the property for Configurables
Definition at line 1231 of file Configurable.py.
| def GaudiKernel.Configurable.ConfigurableUser.propagateProperty | ( | self, | |
| name, | |||
others = None, |
|||
force = True |
|||
| ) |
Propagate the property 'name' (if set) to other configurables (if possible).
'others' can be:
None:
propagate to all the entries in __used_configurables__
a configurable instance:
propagate only to it
list of configurable instances:
propagate to all of them.
The logic is:
- if the local property is set, the other property will be overwritten
- local property not set and other set => keep other
- local property not set and other not set => overwrite the default for
ConfigurableUser instances and set the property for Configurables
Definition at line 1231 of file Configurable.py.
|
staticprivate |
list of ConfigurableUser classes this one is going to query in the apply_configuration method
Definition at line 1152 of file Configurable.py.
|
staticprivate |
Definition at line 1137 of file Configurable.py.
|
staticprivate |
list of ConfigurableUser classes this one is going to modify in the apply_configuration method.
The list may contain class objects, strings representing class objects or tuples with the class object (or a string) as first element and the instance name as second element. If the instance name is None or not present, the function instanceName() is used to determine the name of the instance (the default implementation returns "<this name></em><other name>".
Definition at line 1149 of file Configurable.py.
|
private |
Definition at line 1167 of file Configurable.py.
|
private |
Definition at line 1158 of file Configurable.py.
|
private |
Definition at line 1159 of file Configurable.py.
|
private |
Definition at line 1157 of file Configurable.py.