Organization of Brat source code

From: Anders Holm (aholm@alf.nbi.dk)
Date: Fri May 26 2000 - 08:58:09 EDT

  • Next message: Ian Bearden: "Re: BrDigSi"

    Flemming, Kris and ...
    
    Christian presented here in at NBI ideas about reorganizing the brat
    source code directory into framework code and application code and a
    reorganization within what becomes the framework part.
    
    I think this is a very good idea. I have worked on establishing for my
    self an overview of the framework code by looking at .h and .cxx files and
    by looking at the .html documentation. In this work i categorized classes
    into 
    
      Program structure (modules and containers).
      Classes managing parameters shared by modules.
      Detector description classes.
      Classes for event data at various levels og progress.
      Event IO classes.
    
    I tried for each class to write its parent class and 2 - 6 lines about
    what the class is good for. The process of doing this creates overview but
    is very time consuming. However the result might also be useful to those
    modifying old applications and creating new applications. I would like to
    see such an overview being created as part of the reorganizatiin.
    
    It would be nice also if the naming of classes indicated where a class
    belongs within the framework. Then the lexicografically ordered list of
    classes would the reveal the packaging of the classes in the framework.
    Changing names is a pain to everyone, but please keep the naming aspect in
    mind when new classes are created and when classes may be renamed without
    pain. 
    
    Anders
     
    
    =========================================================
    Anders Holm                     email:   aholm@nbi.dk
    Niels Bohr institute            phone:   (45) 35 32 52 13 
    University of Copenhagen        fax:     (45) 35 32 50 16
    Blegdamsvej 17
    DK-2100 Copenhagen
    Denmark
    ========================================================
    



    This archive was generated by hypermail 2b29 : Fri May 26 2000 - 09:02:23 EDT