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

Public Member Functions

def __init__ (self, name=None, metaData=None)
 
def __str__ (self, prefix='')
 
def metaData (self)
 
def __len__ (self)
 
def __iter__ (self)
 
def properties (self)
 

Static Public Attributes

 auxfiles
 
 minevents
 
 maxeventsfactor
 
 maxeventsstrategy
 
 efficiency
 

Private Member Functions

def _attributeDictionary (self)
 

Private Attributes

 __metadata
 
 __name
 
 __attributes
 

Static Private Attributes

 __slots__
 

Detailed Description

Configuration class for JobTransforms.
It has a number of properties shared among all jobtransforms. Those properties are
processed by class JobTransform.

Definition at line 394 of file TransformConfig.py.

Constructor & Destructor Documentation

◆ __init__()

def python.TransformConfig.TransformConfig.__init__ (   self,
  name = None,
  metaData = None 
)
name is used in printout. The default name is derived from the filename of the python file
where constructor is called

Definition at line 410 of file TransformConfig.py.

410  def __init__(self,name=None,metaData=None):
411  """name is used in printout. The default name is derived from the filename of the python file
412  where constructor is called"""
413  JobConfig.__init__(self,name)
414  self.__metadata = []
415  if metaData is not None:
416  propertyNames = [ d.name() for d in self.properties() ]
417  for m in metaData:
418  if m not in propertyNames:
419  raise TransformConfigError('Requested metadata %s is not an attribute of %s' % (m,self.name()) )
420  self.__metadata.append(m)
421 
422 

Member Function Documentation

◆ __iter__()

def python.TransformConfig.JobConfig.__iter__ (   self)
inherited
Provide iteration over the full list of properties (the Descriptors, not the values)

Definition at line 346 of file TransformConfig.py.

346  def __iter__(self):
347  """Provide iteration over the full list of properties (the Descriptors, not the values)"""
348  return iter(self.properties())
349 
350 

◆ __len__()

def python.TransformConfig.JobConfig.__len__ (   self)
inherited
Return the total number of properties (this class plus all base classes)

Definition at line 341 of file TransformConfig.py.

341  def __len__(self):
342  """Return the total number of properties (this class plus all base classes)"""
343  return len(self.properties())
344 
345 

◆ __str__()

def python.TransformConfig.TransformConfig.__str__ (   self,
  prefix = '' 
)

Reimplemented from python.TransformConfig.JobConfig.

Definition at line 423 of file TransformConfig.py.

423  def __str__(self,prefix=''):
424  me = JobConfig.__str__(self,prefix)
425  #
426  # add list of metadata
427  #
428  prefix += ' '*len(self.name())
429  me += os.linesep + prefix + 'MetaData attributes: '
430  if self.__metadata:
431  me += ','.join(self.__metadata)
432  else:
433  me += '(None)'
434  return me
435 
436 

◆ _attributeDictionary()

def python.TransformConfig.JobConfig._attributeDictionary (   self)
privateinherited
Dictionary to store the values. Used in the class Descriptor.

Definition at line 351 of file TransformConfig.py.

351  def _attributeDictionary(self):
352  """Dictionary to store the values. Used in the class Descriptor."""
353  return self.__attributes
354 
355 

◆ metaData()

def python.TransformConfig.TransformConfig.metaData (   self)
A dictionary of metadata to be added to the metadata of the output files.
Values set to None will not be added to the list. Values will be converted to strings.
Python lists will be transformed to a string with comma separated entries.

Definition at line 437 of file TransformConfig.py.

437  def metaData(self):
438  """A dictionary of metadata to be added to the metadata of the output files.
439  Values set to None will not be added to the list. Values will be converted to strings.
440  Python lists will be transformed to a string with comma separated entries."""
441  meta = {}
442  for name in self.__metadata:
443  value = getattr(self,name)
444  if value is not None:
445  # turn a python list into a string with comma separated entries
446  if type(value).__name__ == 'list': value = ','.join([str(v) for v in value])
447  meta[name] = str(value)
448  return meta
449 

◆ properties()

def python.TransformConfig.JobConfig.properties (   self)
inherited
Return the full list of properties (the descriptors, not the values)

Definition at line 356 of file TransformConfig.py.

356  def properties(self):
357  """Return the full list of properties (the descriptors, not the values)"""

Member Data Documentation

◆ __attributes

python.TransformConfig.JobConfig.__attributes
privateinherited

Definition at line 327 of file TransformConfig.py.

◆ __metadata

python.TransformConfig.TransformConfig.__metadata
private

Definition at line 414 of file TransformConfig.py.

◆ __name

python.TransformConfig.JobConfig.__name
privateinherited
name is used in printout. The default name is derived from the filename of the python file
where constructor is called

Definition at line 326 of file TransformConfig.py.

◆ __slots__

python.TransformConfig.TransformConfig.__slots__
staticprivate
Configuration class for JobTransforms.
It has a number of properties shared among all jobtransforms. Those properties are
processed by class JobTransform.

Definition at line 398 of file TransformConfig.py.

◆ auxfiles

python.TransformConfig.TransformConfig.auxfiles
static

Definition at line 401 of file TransformConfig.py.

◆ efficiency

python.TransformConfig.TransformConfig.efficiency
static

Definition at line 407 of file TransformConfig.py.

◆ maxeventsfactor

python.TransformConfig.TransformConfig.maxeventsfactor
static

Definition at line 403 of file TransformConfig.py.

◆ maxeventsstrategy

python.TransformConfig.TransformConfig.maxeventsstrategy
static

Definition at line 405 of file TransformConfig.py.

◆ minevents

python.TransformConfig.TransformConfig.minevents
static

Definition at line 402 of file TransformConfig.py.


The documentation for this class was generated from the following file:
createLinkingScheme.iter
iter
Definition: createLinkingScheme.py:62
python.TestDriveDummies.properties
dictionary properties
Definition: TestDriveDummies.py:14
python.Bindings.__iter__
__iter__
Definition: Control/AthenaPython/python/Bindings.py:794
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
dumpHVPathFromNtuple.append
bool append
Definition: dumpHVPathFromNtuple.py:91
python.CaloAddPedShiftConfig.type
type
Definition: CaloAddPedShiftConfig.py:42
TCS::join
std::string join(const std::vector< std::string > &v, const char c=',')
Definition: Trigger/TrigT1/L1Topo/L1TopoCommon/Root/StringUtils.cxx:10
str
Definition: BTagTrackIpAccessor.cxx:11