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 395 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 411 of file TransformConfig.py.

    def __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"""
        JobConfig.__init__(self,name)
        self.__metadata = []
        if metaData is not None:
            propertyNames = [ d.name() for d in self.properties() ]
            for m in metaData:
                if m not in propertyNames:
                    raise TransformConfigError('Requested metadata %s is not an attribute of %s' % (m,self.name()) )
                self.__metadata.append(m)
 
 

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 347 of file TransformConfig.py.

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

__len__()

def python.TransformConfig.JobConfig.__len__ (   self )

inherited

Return the total number of properties (this class plus all base classes)

Definition at line 342 of file TransformConfig.py.

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

__str__()

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

Reimplemented from python.TransformConfig.JobConfig.

Definition at line 424 of file TransformConfig.py.

    def __str__(self,prefix=''):
        me = JobConfig.__str__(self,prefix)
        #
        # add list of metadata
        #
        prefix += ' '*len(self.name())
        me += os.linesep + prefix + 'MetaData attributes: '
        if self.__metadata:
            me += ','.join(self.__metadata)
        else:
            me += '(None)'
        return me
 
     

_attributeDictionary()

def python.TransformConfig.JobConfig._attributeDictionary (   self )

privateinherited

Dictionary to store the values. Used in the class Descriptor.

Definition at line 352 of file TransformConfig.py.

    def _attributeDictionary(self):
        """Dictionary to store the values. Used in the class Descriptor."""
        return self.__attributes
 
 

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 438 of file TransformConfig.py.

    def 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."""
        meta = {}
        for name in self.__metadata:
            value = getattr(self,name)
            if value is not None:
                # turn a python list into a string with comma separated entries
                if type(value).__name__ == 'list': value = ','.join([str(v) for v in value])
                meta[name] = str(value)
        return meta
 

properties()

def python.TransformConfig.JobConfig.properties (   self )

inherited

Return the full list of properties (the descriptors, not the values)

Definition at line 357 of file TransformConfig.py.

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

Member Data Documentation

__attributes

python.TransformConfig.JobConfig.__attributes

privateinherited

Definition at line 328 of file TransformConfig.py.

__metadata

python.TransformConfig.TransformConfig.__metadata

private

Definition at line 415 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 327 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 399 of file TransformConfig.py.

auxfiles

python.TransformConfig.TransformConfig.auxfiles

static

Definition at line 402 of file TransformConfig.py.

efficiency

python.TransformConfig.TransformConfig.efficiency

static

Definition at line 408 of file TransformConfig.py.

maxeventsfactor

python.TransformConfig.TransformConfig.maxeventsfactor

static

Definition at line 404 of file TransformConfig.py.

maxeventsstrategy

python.TransformConfig.TransformConfig.maxeventsstrategy

static

Definition at line 406 of file TransformConfig.py.

minevents

python.TransformConfig.TransformConfig.minevents

static

Definition at line 403 of file TransformConfig.py.

---

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

• TransformConfig.py