The Gaudi Framework  v41r0 (bdbe7744)
Loading...
Searching...
No Matches
GaudiKernel.Configurable.ConfigurableAlgorithm Class Reference
Inheritance diagram for GaudiKernel.Configurable.ConfigurableAlgorithm:
Collaboration diagram for GaudiKernel.Configurable.ConfigurableAlgorithm:

Public Member Functions

 __init__ (self, name=Configurable.DefaultName)
 __deepcopy__ (self, memo)
 getHandle (self)
 getGaudiType (cls)
 getJobOptName (self)
 __and__ (self, rhs)
 __or__ (self, rhs)
 __invert__ (self)
 __rshift__ (self, rhs)
 visitNode (self, visitor)
 __eq__ (self, other)
 __hash__ (self)
Public Member Functions inherited from GaudiKernel.Configurable.Configurable
 __new__ (cls, *args, **kwargs)
 __init__ (self, name=DefaultName)
 __getstate__ (self)
 __getnewargs__ (self)
 __setstate__ (self, dict)
 __len__ (self)
 __iter__ (self)
 __deepcopy__ (self, memo)
 __iadd__ (self, configs, descr=None)
 __getattr__ (self, attr)
 __setattr__ (self, name, value)
 __delattr__ (self, attr)
 __bool__ (self)
 remove (self, items)
 removeAll (self)
 copyChild (self, child)
 setParent (self, parentName)
 getParent (self)
 hasParent (self, parent)
 copyChildAndSetParent (self, cfg, parent)
 getChildren (self)
 getTools (self)
 children (self)
 getAllChildren (self)
 getSequence (self)
 setup (self)
 getProperties (self)
 getPropertiesWithDescription (self)
 getValuedProperties (self)
 properties (self)
 getDefaultProperties (cls)
 getDefaultProperty (cls, name)
 getProp (self, name)
 setProp (self, name, value)
 isPropertySet (self, name)
 getType (cls)
 getName (self)
 name (self)
 isPublic (self)
 jobOptName (self)
 getFullName (self)
 getFullJobOptName (self)
 getPrintTitle (self)
 getTitleName (self)
 setDefaults (cls, handle)
 clone (self, name=None, **kwargs)
 splitName (self)
 addTool (self, tool, name=None)
 __repr__ (self)
 __str__ (self, indent=0, headerLastIndentUnit=indentUnit)
 isApplicable (self)
Public Member Functions inherited from GaudiKernel.ConfigurableMeta.ConfigurableMeta
 __new__ (self, name, bases, dct)
 __call__ (cls, *args, **kwargs)

Protected Member Functions

 _visitSubNodes (self, visitor)
Protected Member Functions inherited from GaudiKernel.Configurable.Configurable
 _isInSetDefaults (self)

Protected Attributes

 _jobOptName = name[name.find("/") + 1 :]
Protected Attributes inherited from GaudiKernel.Configurable.Configurable
 _name = self.__class__.DefaultedName
bool _inSetDefaults = False
bool _initok = True
bool _setupok = False
bool _unpickling = False
 _properties

Static Private Attributes

dict __slots__

Additional Inherited Members

Public Attributes inherited from GaudiKernel.Configurable.Configurable
 configurables
Static Public Attributes inherited from GaudiKernel.Configurable.Configurable
 propertyNoValue
str indentUnit = "| "
int printHeaderWidth = 100
int printHeaderPre = 5
dict allConfigurables = {}
dict configurableServices = {}
Static Protected Member Functions inherited from GaudiKernel.Configurable.Configurable
 _printHeader (indentStr, title)
 _printFooter (indentStr, title)
Static Protected Attributes inherited from GaudiKernel.Configurable.Configurable
bool _configurationLocked = False

Detailed Description

Definition at line 1128 of file Configurable.py.

Constructor & Destructor Documentation

◆ __init__()

GaudiKernel.Configurable.ConfigurableAlgorithm.__init__ ( self,
name = Configurable.DefaultName )

Definition at line 1133 of file Configurable.py.

1133 def __init__(self, name=Configurable.DefaultName):
1134 super().__init__(name)
1135 name = self.getName()
1136 self._jobOptName = name[name.find("/") + 1 :] # strips class
1137

Member Function Documentation

◆ __and__()

GaudiKernel.Configurable.ConfigurableAlgorithm.__and__ ( self,
rhs )

Definition at line 1154 of file Configurable.py.

1154 def __and__(self, rhs):
1155 if rhs is CFTrue:
1156 return self
1157 elif rhs is CFFalse:
1158 return CFFalse
1159 return AndNode(self, rhs)
1160

◆ __deepcopy__()

GaudiKernel.Configurable.ConfigurableAlgorithm.__deepcopy__ ( self,
memo )

Definition at line 1138 of file Configurable.py.

1138 def __deepcopy__(self, memo):
1139 return self # algorithms are always shared
1140

◆ __eq__()

GaudiKernel.Configurable.ConfigurableAlgorithm.__eq__ ( self,
other )

Definition at line 1182 of file Configurable.py.

1182 def __eq__(self, other):
1183 return repr(self) == repr(other)
1184

◆ __hash__()

GaudiKernel.Configurable.ConfigurableAlgorithm.__hash__ ( self)
Return a unique identifier for this object.

As we use the `repr` of this object to check for equality, we use it
here to define uniqueness.

Definition at line 1185 of file Configurable.py.

1185 def __hash__(self):
1186 """Return a unique identifier for this object.
1187
1188 As we use the `repr` of this object to check for equality, we use it
1189 here to define uniqueness.
1190 """
1191 # The hash of the 1-tuple containing the repr of this object
1192 return hash((repr(self),))
1193
1194

◆ __invert__()

GaudiKernel.Configurable.ConfigurableAlgorithm.__invert__ ( self)

Definition at line 1168 of file Configurable.py.

1168 def __invert__(self):
1169 return InvertNode(self)
1170

◆ __or__()

GaudiKernel.Configurable.ConfigurableAlgorithm.__or__ ( self,
rhs )

Definition at line 1161 of file Configurable.py.

1161 def __or__(self, rhs):
1162 if rhs is CFFalse:
1163 return self
1164 elif rhs is CFTrue:
1165 return CFTrue
1166 return OrNode(self, rhs)
1167

◆ __rshift__()

GaudiKernel.Configurable.ConfigurableAlgorithm.__rshift__ ( self,
rhs )

Definition at line 1171 of file Configurable.py.

1171 def __rshift__(self, rhs):
1172 return OrderedNode(self, rhs)
1173

◆ _visitSubNodes()

GaudiKernel.Configurable.ConfigurableAlgorithm._visitSubNodes ( self,
visitor )
protected

Definition at line 1179 of file Configurable.py.

1179 def _visitSubNodes(self, visitor):
1180 pass
1181

◆ getGaudiType()

GaudiKernel.Configurable.ConfigurableAlgorithm.getGaudiType ( cls)

Definition at line 1147 of file Configurable.py.

1147 def getGaudiType(cls):
1148 return "Algorithm"
1149

◆ getHandle()

GaudiKernel.Configurable.ConfigurableAlgorithm.getHandle ( self)

Definition at line 1141 of file Configurable.py.

1141 def getHandle(self):
1142 return iAlgorithm( # noqa: F821 (to avoid circular dependeny)
1143 self.getJobOptName()
1144 )
1145

◆ getJobOptName()

GaudiKernel.Configurable.ConfigurableAlgorithm.getJobOptName ( self)

Reimplemented from GaudiKernel.Configurable.Configurable.

Definition at line 1150 of file Configurable.py.

1150 def getJobOptName(self):
1151 return self._jobOptName
1152

◆ visitNode()

GaudiKernel.Configurable.ConfigurableAlgorithm.visitNode ( self,
visitor )

Definition at line 1174 of file Configurable.py.

1174 def visitNode(self, visitor):
1175 visitor.enter(self)
1176 self._visitSubNodes(visitor)
1177 visitor.leave(self)
1178

Member Data Documentation

◆ __slots__

dict GaudiKernel.Configurable.ConfigurableAlgorithm.__slots__
staticprivate
Initial value:
= {
"_jobOptName": 0,
}

Definition at line 1129 of file Configurable.py.

◆ _jobOptName

GaudiKernel.Configurable.ConfigurableAlgorithm._jobOptName = name[name.find("/") + 1 :]
protected

Definition at line 1136 of file Configurable.py.


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