Functions
	add_args (parser)
	_mapToCpp (t)
	_toCamelCase (identifier)
	_createAddSpecificationList (nameList)
	_createDefineSpecificationList (nameTypeList)
	_createReadSpecificationList (nameTypeList)
	_createGetterList (nameTypeList)
	_createSetterList (nameTypeList)
	_createAttrDefinitions (nameTypeList)
	_createAttrConstructorList (nameList)
	_writeToFile (fname, template, mapping)
	create_classes_from_folder (folder, attrExcludeList, attrIncludeList, containerName, objectName)
	main ()

Variables
str	__doc__
	_dbSvc = cool.DatabaseSvcFactory.databaseService()
	_cliddb = clidGenerator("")
str	_container_header
str	_container_src
str	_object_header
str	_object_src

Function Documentation

◆ _createAddSpecificationList()

CreateClassesForFolder._createAddSpecificationList ( nameList )

protected

Definition at line 235 of file CreateClassesForFolder.py.

def _createAddSpecificationList(nameList):
    _l = '    attrList[specificationName(e{AttrName})].setValue(item.{attrName}());'
    result = []
    for name in nameList:
        result.append(_l.format(AttrName=name, attrName=_toCamelCase(name)))
    return '\n'.join(result)
 

◆ _createAttrConstructorList()

CreateClassesForFolder._createAttrConstructorList ( nameList )

protected

Definition at line 277 of file CreateClassesForFolder.py.

def _createAttrConstructorList(nameList):
    _l = ' , m_{attrName}({attrName})'
    result = []
    for n in nameList:
        result.append(_l.format(attrName=_toCamelCase(n)))
    return '\n'.join(result)
 

◆ _createAttrDefinitions()

CreateClassesForFolder._createAttrDefinitions ( nameTypeList )

protected

Definition at line 270 of file CreateClassesForFolder.py.

def _createAttrDefinitions(nameTypeList):
    _l = '  {attrType} m_{attrName} = 0;'
    result = []
    for (n, t) in nameTypeList:
        result.append(_l.format(attrName=_toCamelCase(n), attrType=_mapToCpp(t)))
    return '\n'.join(result)
 

◆ _createDefineSpecificationList()

CreateClassesForFolder._createDefineSpecificationList ( nameTypeList )

protected

Definition at line 242 of file CreateClassesForFolder.py.

def _createDefineSpecificationList(nameTypeList):
    _l = '  this->addSpecification(e{AttrName}, "{AttrName}", "{attrType}");'
    result = []
    for (n, t) in nameTypeList:
        result.append(_l.format(AttrName=n, attrType=_mapToCpp(t)))
    return '\n'.join(result)
 

◆ _createGetterList()

CreateClassesForFolder._createGetterList ( nameTypeList )

protected

Definition at line 256 of file CreateClassesForFolder.py.

def _createGetterList(nameTypeList):
    _l = '  {attrType} {attrName}() const {{ return m_{attrName}; }}'
    result = []
    for (n, t) in nameTypeList:
        result.append(_l.format(attrName=_toCamelCase(n), attrType=_mapToCpp(t)))
    return '\n'.join(result)
 

◆ _createReadSpecificationList()

CreateClassesForFolder._createReadSpecificationList ( nameTypeList )

protected

Definition at line 249 of file CreateClassesForFolder.py.

def _createReadSpecificationList(nameTypeList):
    _l = '    auto {attrName} = attrList[specificationName(e{AttrName})].data<{attrType}>();'
    result = []
    for (n, t) in nameTypeList:
        result.append(_l.format(AttrName=n, attrName=_toCamelCase(n), attrType=_mapToCpp(t)))
    return '\n'.join(result)
 

◆ _createSetterList()

CreateClassesForFolder._createSetterList ( nameTypeList )

protected

Definition at line 263 of file CreateClassesForFolder.py.

def _createSetterList(nameTypeList):
    _l = '  void set{AttrName}({attrType} {attrName}) {{ m_{attrName} = {attrName}; }}'
    result = []
    for (n, t) in nameTypeList:
        result.append(_l.format(AttrName=n, attrName=_toCamelCase(n), attrType=_mapToCpp(t)))
    return '\n'.join(result)
 

◆ _mapToCpp()

CreateClassesForFolder._mapToCpp ( t )

protected

Definition at line 219 of file CreateClassesForFolder.py.

def _mapToCpp(t):
    _m = {
        'UInt16': 'unsigned short',
        'UInt32': 'unsigned int',
        'UInt63': 'unsigned long long',
        'Int16' : 'short',
        'Int32' : 'int',
        'Double': 'double',
        'Blob64k': 'char*',
        'String255': 'char*'
        }
    return _m[t]
 

◆ _toCamelCase()

CreateClassesForFolder._toCamelCase ( identifier )

protected

Definition at line 232 of file CreateClassesForFolder.py.

def _toCamelCase(identifier):
    return '{0}{1}'.format(identifier[0].lower(), identifier[1:])
 

◆ _writeToFile()

CreateClassesForFolder._writeToFile	(	fname,
		template,
		mapping )

protected

Definition at line 284 of file CreateClassesForFolder.py.

def _writeToFile(fname, template, mapping):
    f = open(fname, 'w')
    f.write(string.Template(template).substitute(mapping))
    f.close()
 

◆ add_args()

CreateClassesForFolder.add_args ( parser )

Add arguments to the ArgumentParser @parser.

Definition at line 209 of file CreateClassesForFolder.py.

def add_args(parser):
    """ Add arguments to the ArgumentParser @parser. """
    parser.add_argument('folder', help='Folder which the class should represent')
    parser.add_argument('--include', help='Comma separated list of attributes to include')
    parser.add_argument('--exclude', help='Comma separated list of attributes to exclude')
    parser.add_argument('--objectName', help='Name of object class')
    parser.add_argument('--containerName', help='Name of container class')
    parser.add_argument('--db', help='Connection string of the database',
                        default='COOLONL_TRIGGER/CONDBR2')
    

◆ create_classes_from_folder()

CreateClassesForFolder.create_classes_from_folder	(	folder,
		attrExcludeList,
		attrIncludeList,
		containerName,
		objectName )

Does the actual work ...

Definition at line 289 of file CreateClassesForFolder.py.

def create_classes_from_folder(folder, attrExcludeList, attrIncludeList, containerName, objectName):
    """ Does the actual work ... """
    folderName = folder.fullPath().split('/')[-1]
    attrNames = [ps.name() for ps in folder.payloadSpecification()]
    if attrIncludeList:
        attrNames = filter(lambda n: n in attrIncludeList, attrNames)
    elif attrExcludeList:
        attrNames = filter(lambda n: n not in attrExcludeList, attrNames)
 
    attrTypes = [ps.storageType().name() for ps in folder.payloadSpecification() \
                 if ps.name() in attrNames]
    attrNameTypes = zip(attrNames, attrTypes)
 
    if not containerName:
        containerName = 'L1Calo{0}Container'.format(folderName)
    if not objectName:
        objectName = 'L1Calo{0}'.format(folderName)
 
    # prepare the replacements for the container class
    mapping = {}
    mapping['CommandLine'] = ' '.join(sys.argv)
    mapping['ContainerName'] = containerName
    mapping['CONTAINERNAME'] = containerName.upper()
    mapping['FolderName'] = folderName
    mapping['folderName'] = _toCamelCase(folderName)
    mapping['ObjectName'] = objectName
    mapping['EnumAttrSpecification'] = ', '.join(['e{0}'.format(n) for n in attrNames])
    mapping['FullFolderPath'] = folder.fullPath()
    mapping['ClassDefMacro'] = \
       'CLASS_DEF( {0}, {1}, 1 )'.format(containerName,
                                         _cliddb.genClidFromName(containerName))
    
    mapping['DefineSpecificationList'] = _createDefineSpecificationList(attrNameTypes)
    mapping['AddSpecificationList'] = _createAddSpecificationList(attrNames)
    mapping['ReadSpecificationList'] = _createReadSpecificationList(attrNameTypes)
    mapping['AttrList'] = ', '.join(map(_toCamelCase, attrNames))
 
    # write the files
    _writeToFile('{0}.h'.format(containerName), _container_header, mapping)
    _writeToFile('{0}.cxx'.format(containerName), _container_src, mapping)
 
    # prepare the replacements for the object class
    for not_needed in ('ContainerName', 'CONTAINERNAME', 'FolderName', 'folderName',
                       'EnumAttrSpecification', 'ClassDefMacro', 'DefineSpecificationList',
                       'AddSpecificationList', 'ReadSpecificationList', 'AttrList'):
        del mapping[not_needed]
    mapping['OBJECTNAME'] = objectName.upper()
    mapping['AttrTypeNameList'] = ', '.join(['{0} {1}'.format(_mapToCpp(t), _toCamelCase(n)) for (n,t) in attrNameTypes])
    mapping['GetterList'] = _createGetterList(attrNameTypes)
    mapping['SetterList'] = _createSetterList(attrNameTypes)
    mapping['AttrDefinitions'] = _createAttrDefinitions(attrNameTypes)
    mapping['AttrConstructorList'] = _createAttrConstructorList(attrNames)
 
    # write the files
    _writeToFile('{0}.h'.format(objectName), _object_header, mapping)
    _writeToFile('{0}.cxx'.format(objectName), _object_src, mapping)
 
    # redefine mapping for slection.xml / *PACKAGE*Dict.h
    mapping = {
        'cont' : containerName,
        'obj' : objectName,
        'id' : str(uuid.uuid4()).upper()
    }
    print
    print '[I] Add the following to the selection.xml file:'
    print '   <class name="{cont}" id="{id}" />'.format(**mapping)
    print '   <class name="{cont}::const_iterator" />'.format(**mapping)
    print '   <class name="{obj}" />'.format(**mapping)
    print
    print '[I] Add the following to the TrigT1CaloCalibConditionsDict.h file:'
    print '#include "TrigT1CaloCalibConditions/{cont}.h"'.format(**mapping)
    print '#include "TrigT1CaloCalibConditions/{obj}.h"'.format(**mapping)
    print
    print '   {cont}::const_iterator {cont}ConstInterator;'.format(**mapping)
 

◆ main()

CreateClassesForFolder.main ( )

Entry point

Definition at line 364 of file CreateClassesForFolder.py.

def main():
    """ Entry point """
    parser = argparse.ArgumentParser(description='Create C++ classes that represent COOL database folders')
    add_args(parser)
    args = parser.parse_args()
 
    if args.include and args.exclude:
        raise RuntimeError("Options --include and --exclude are mutually exclusive.")
 
    db = _dbSvc.openDatabase(args.db)
    folder = db.getFolder(args.folder)
 
    create_classes_from_folder(folder,
                               args.exclude.split(',') if args.exclude else None,
                               args.include.split(',') if args.include else None,
                               args.containerName, args.objectName)
 

Variable Documentation

◆ doc

str CreateClassesForFolder.__doc__

private

Initial value:

=  """
CreateClassesForFolder.py
 
Python script that creates C++ .h/.cxx files that contain the container and object class
representing the structure of a database folder.
"""

Definition at line 5 of file CreateClassesForFolder.py.

◆ _cliddb

CreateClassesForFolder._cliddb = clidGenerator("")

protected

Definition at line 22 of file CreateClassesForFolder.py.

◆ _container_header

str CreateClassesForFolder._container_header

protected

Definition at line 24 of file CreateClassesForFolder.py.

◆ _container_src

str CreateClassesForFolder._container_src

protected

Definition at line 84 of file CreateClassesForFolder.py.

◆ _dbSvc

CreateClassesForFolder._dbSvc = cool.DatabaseSvcFactory.databaseService()

protected

Definition at line 21 of file CreateClassesForFolder.py.

◆ _object_header

str CreateClassesForFolder._object_header

protected

Initial value:

=  """// -*- C++ -*-
#ifndef TRIGT1CALOCALIBCONDITIONS_${OBJECTNAME}_H
#define TRIGT1CALOCALIBCONDITIONS_${OBJECTNAME}_H
 
/**
 * Folder <-> Object mapping for ${FullFolderPath} .
 * Automatically created using:
 *
 * ${CommandLine}
 */
class ${ObjectName}
{
public:
  ${ObjectName}() {}
  ${ObjectName}(unsigned int channelId, ${AttrTypeNameList});
 
  unsigned int channelId() const { return m_channelId; }
${GetterList}
 
  void setChannelId(unsigned int channelId) { m_channelId = channelId; }
${SetterList}
 
private:
  unsigned int m_channelId = 0;
${AttrDefinitions}
};
 
#endif // TRIGT1CALOCALIBCONDITIONS_${OBJECTNAME}_H
"""

Definition at line 170 of file CreateClassesForFolder.py.

◆ _object_src

str CreateClassesForFolder._object_src

protected

Initial value:

=  """#include "TrigT1CaloCalibConditions/${ObjectName}.h"
 
${ObjectName}::${ObjectName}(unsigned int channelId, ${AttrTypeNameList})
 : m_channelId(channelId)
${AttrConstructorList}
{
}
"""

Definition at line 200 of file CreateClassesForFolder.py.

Functions

Variables

Function Documentation

◆ _createAddSpecificationList()

◆ _createAttrConstructorList()

◆ _createAttrDefinitions()

◆ _createDefineSpecificationList()

◆ _createGetterList()

◆ _createReadSpecificationList()

◆ _createSetterList()

◆ _mapToCpp()

◆ _toCamelCase()

◆ _writeToFile()

◆ add_args()

◆ create_classes_from_folder()

◆ main()

Variable Documentation

◆ __doc__

◆ _cliddb

◆ _container_header

◆ _container_src

◆ _dbSvc

◆ _object_header

◆ _object_src

◆ doc