conffwk.dal.DalType Class Reference

Inheritance diagram for conffwk.dal.DalType:

Collaboration diagram for conffwk.dal.DalType:

Public Member Functions
	__init__ (cls, name, bases, dct)
	pyclassName (cls)
	pyoksTypes (cls)

Private Attributes
	__okstypes__ = alltypes

Detailed Description

This class is the metaclass that every DAL class will be created with.

DalType is a metaclass (something like a C++ template) that allows us to
create DAL classes without having to go through the 'exec' burden all the
time and being, therefore, much faster than that mechanism. The idea is
that we create DAL types everytime we see a new class and archive this in a
cache, together with the configuration object. Everytime an object of a
certain OKS type is needed by the user, we make use of the generated class
living in that cache to make it a new DAL object.

The DAL type consistency checks are limited by the amount of generic
functionality one can extract by looking at the C++ Configuration class.

The work here is modelled after the old PyDALBase implementation that used
to live in the "genconffwk" package.

Definition at line 520 of file dal.py.

Constructor & Destructor Documentation

__init__()

conffwk.dal.DalType.__init__	(		cls,
			name,
			bases,
			dct )

Class constructor.

Keyword Parameters:

cls -- This is a pointer to the class being constructed

name -- The name that the class will have

bases -- These are the classes, objects of the new generated type will
inherit from. It is useful in our context, to express the OKS
inheritance relations between the classes.

dct -- This is a dictionary that will contain mappings between
methods/attributes of the newly generated class and values or methods
that will be bound to it. The dictionary should contain a pointer to
the class schema, and that should be called '__schema__'.

Definition at line 539 of file dal.py.

    def __init__(cls, name, bases, dct):
        """Class constructor.
 
        Keyword Parameters:
 
        cls -- This is a pointer to the class being constructed
 
        name -- The name that the class will have
 
        bases -- These are the classes, objects of the new generated type will
        inherit from. It is useful in our context, to express the OKS
        inheritance relations between the classes.
 
        dct -- This is a dictionary that will contain mappings between
        methods/attributes of the newly generated class and values or methods
        that will be bound to it. The dictionary should contain a pointer to
        the class schema, and that should be called '__schema__'.
        """
        # set all types as expected by the DAL
        alltypes = [name]
        for b in bases:
            if hasattr(b, 'pyoksTypes'):
                for t in b.pyoksTypes():
                    if t not in alltypes:
                        alltypes.append(t)
 
        super(DalType, cls).__init__(name, bases, dct)
        cls.__okstypes__ = alltypes
 

Member Function Documentation

pyclassName()

conffwk.dal.DalType.pyclassName

(

cls

)

Returns this class name

Definition at line 568 of file dal.py.

    def pyclassName(cls):
        """Returns this class name"""
        return cls.__name__
 

pyoksTypes()

conffwk.dal.DalType.pyoksTypes

(

cls

)

Returns a join of this class and base class names

Definition at line 572 of file dal.py.

    def pyoksTypes(cls):
        """Returns a join of this class and base class names"""
        return cls.__okstypes__
 
 

Member Data Documentation

__okstypes__

conffwk.dal.DalType.__okstypes__ = alltypes

private

Definition at line 566 of file dal.py.

---

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

• /github/workspace/dunedaq/sourcecode/conffwk/python/conffwk/dal.py