StRoot: St_base/St_Module.cxx Source File

00001 //*-- Author :    Valery Fine   24/03/98
00002 // $Id: St_Module.cxx,v 1.18 2003/04/30 20:39:12 perev Exp $
00003 
00004 #include <assert.h>
00005 #include <string.h>
00006 #include "St_Module.h"
00007 
00008 
00009 ClassImp(St_Module)
00010 
00011 
00012 
00013 //                                                                            //
00014 //  St_Module                                                                  //
00015 //                                                                            //
00016 //  St_Module is a virtual base class to call the begin_html <A HREF="http://www.rhic.bnl.gov/STAR/html/ssd_l/staf_l/STAF-current/pams/pams.html">PAMS - Physics Analysis Modules</A> end_html
00017 //  modules from C++ programs and begin_html <A HREF="http://root.cern.ch">ROOT</A> end_html batch and interactive environments.
00018 //                                                                            //
00019 //  Note: This class uses the "default" parameter term.                       //
00020 //        The value of the default parameter is defined as follows:           //
00021 //                                                                            //
00022 //        "it is either "zero" or                                             //
00023 //         the last value of the "missed" parameters                          //
00024 //                                                                            //
00025 //         Calling St_Module::Call, St_Module::ExecuteModule methods with     //
00026 //         any parameter = 0 means the wrapped STAR module will be called     //
00027 //         with "default" parameter instead.                                  //
00028 //                                                                            //
00029 //                                                                            //
00030 // Begin_Html <P ALIGN=CENTER> <IMG SRC="gif/Module2Root.gif"> </P> End_Html  
00031 //                                                                            //
00033 
00034 //______________________________________________________________________________
00035 St_Module::St_Module() 
00036 : fParams(0), fHeaders(0), fName(0), fIndex(0)
00037 {  // Default ctor;
00038 }
00039 //______________________________________________________________________________
00040 St_Module::St_Module(char *, TTable *,TTable *,TTable *,TTable *
00041                             ,TTable *,TTable *,TTable *,TTable *
00042                             ,TTable *,TTable *,TTable *,TTable *
00043                             ,TTable *,TTable *,TTable *,TTable *
00044                             ,TTable *,TTable *,TTable *,TTable *
00045                             ,TTable *,TTable *,TTable *,TTable *
00046                             ,TTable *,TTable *,TTable *,TTable *
00047                             ,TTable *,TTable *,TTable *,TTable *
00048                             ,TTable *,TTable *,TTable *,TTable *
00049                             ,TTable *,TTable *
00050                             ) 
00051 : fParams(0), fHeaders(0), fName(0), fIndex(38)
00052 // : TNamed(name)
00053 {}
00054 //______________________________________________________________________________
00055 St_Module::St_Module(        TTable *f1,TTable *f2,TTable *f3,TTable *f4
00056                             ,TTable *f5,TTable *f6,TTable *f7,TTable *f8
00057                             ,TTable *f9,TTable *f10,TTable *f11,TTable *f12
00058                             ,TTable *f13,TTable *f14,TTable *f15,TTable *f16
00059                             ,TTable *f17,TTable *f18,TTable *f19,TTable *f20
00060                             ,TTable *f21,TTable *f22,TTable *f23,TTable *f24
00061                             ,TTable *f25,TTable *f26,TTable *f27,TTable *f28
00062                             ,TTable *f29,TTable *f30,TTable *f31,TTable *f32
00063                             ,TTable *f33,TTable *f34,TTable *f35,TTable *f36
00064                             ,TTable *f37,TTable *f38
00065                             ) 
00066 : fParams(0), fHeaders(0), fName(0), fIndex(38)
00067 {
00068   SetAllParameters( f1, f2, f3, f4, f5, f6, f7, f8, f9,f10,f11,f12
00069                   ,f13,f14,f15,f16,f17,f18,f19,f20,f21,f22,f23,f24
00070                   ,f25,f26,f27,f28,f29,f30,f31,f32,f33,f34,f35,f36
00071                   ,f37,f38
00072                   );
00073 }
00074 //______________________________________________________________________________
00075 St_Module::~St_Module()
00076 {
00077   if (fHeaders) fHeaders->Delete();
00078   SafeDelete(fHeaders);
00079   SafeDelete(fParams);     
00080 }
00081 //______________________________________________________________________________
00082 void St_Module::ClearParams()
00083 {
00084   if (fHeaders) {
00085      fHeaders->Delete();
00086      fParams->Clear();
00087   }
00088 }
00089 //______________________________________________________________________________
00090 void St_Module::SetAllParameters(TTable *f1,TTable *f2,TTable *f3,TTable *f4
00091                                ,TTable *f5,TTable *f6,TTable *f7,TTable *f8
00092                                ,TTable *f9,TTable *f10,TTable *f11,TTable *f12
00093                                ,TTable *f13,TTable *f14,TTable *f15,TTable *f16
00094                                ,TTable *f17,TTable *f18,TTable *f19,TTable *f20
00095                                ,TTable *f21,TTable *f22,TTable *f23,TTable *f24
00096                                ,TTable *f25,TTable *f26,TTable *f27,TTable *f28
00097                                ,TTable *f29,TTable *f30,TTable *f31,TTable *f32
00098                                ,TTable *f33,TTable *f34,TTable *f35,TTable *f36
00099                                ,TTable *f37,TTable *f38
00100                                ) 
00101 {  
00102   ClearParams();
00103   SetParameter(f38);
00104   SetParameter(f37);
00105   SetParameter(f36);
00106   SetParameter(f35);
00107   SetParameter(f34);
00108   SetParameter(f33);
00109   SetParameter(f32);
00110   SetParameter(f31);
00111   SetParameter(f30);
00112   SetParameter(f29);
00113   SetParameter(f28);
00114   SetParameter(f27);
00115   SetParameter(f26);
00116   SetParameter(f25);
00117   SetParameter(f24);
00118   SetParameter(f23);
00119   SetParameter(f22);
00120   SetParameter(f21);
00121   SetParameter(f20);
00122   SetParameter(f19);
00123   SetParameter(f18);
00124   SetParameter(f17);
00125   SetParameter(f16);
00126   SetParameter(f15);
00127   SetParameter(f14);
00128   SetParameter(f13);
00129   SetParameter(f12);
00130   SetParameter(f11);
00131   SetParameter(f10);
00132   SetParameter(f9);
00133   SetParameter(f8);
00134   SetParameter(f7);
00135   SetParameter(f6);
00136   SetParameter(f5);
00137   SetParameter(f4);
00138   SetParameter(f3);
00139   SetParameter(f2);
00140   SetParameter(f1);
00141 }
00142 
00143 //______________________________________________________________________________
00144 void St_Module::SetParameter(TTable *f)
00145 {
00146   if (!fIndex) return;
00147   if (f) {
00148     if (!fParams) {
00149        fParams  = new TObjArray(fIndex);
00150        fHeaders = new TObjArray(fIndex);
00151     }
00152     fParams->AddAt(f,fIndex-1);
00153     fHeaders->AddAt(new St_table_header(f),fIndex-1);
00154   }
00155   fIndex--;
00156 }
00157 //______________________________________________________________________________
00158 Int_t St_Module::CheckParameters(const Char_t *names[])
00159 {
00161  //                                                                //
00162  // CheckParameters()                                              //
00163  //                                                                //
00164  //  Check whether all parameters are defined to call ExecutModule //
00165  //  properly ?                                                    //
00166  //                                                                //
00167  //  Return:                                                       //
00168  //      0  = Ok, All parameters are "well" defined                //
00169  //     +n  = the n parameters were not defined yet.              //
00170  //                                                                //
00171  //  To print the list of parameters one may call                  //
00172  //           St_Module::Print() method                            //
00173  //                                                                //
00175    Int_t errcode = 0;
00176    if (fParams) {
00177      TObjArray &thisParams =  *fParams;
00178      Int_t thisSize = thisParams.GetSize();
00179      for (Int_t i=0;i<thisSize;i++) 
00180        if (!thisParams[i]) { 
00181 //           errcode = St_Module::ExecuteModule();
00182            errcode++;
00183            if (errcode == 1) 
00184                fprintf(stderr, "\n \t ***** Error calling module <%s> *****\n"
00185                              ,GetName()); 
00186            const Char_t *suffix[4]={"st","nd","d","th"};
00187            Int_t indx = i%10;
00188            if ( (10 < i && i < 20) || indx > 3 || indx == 0) indx = 4;
00189            indx--;
00190            const Char_t *name = names ? names[i] : "unknown" ;
00191            fprintf(stderr, "\t %i-%s table of <%s> has not been defined yet\n"
00192                    ,i,suffix[indx],name);
00193        }
00194 //=====     assert (!errcode);
00195    }
00196    return errcode;
00197 }
00198 //______________________________________________________________________________
00199 Int_t St_Module::CheckResults(Int_t res, const Char_t *names[])
00200 {
00201    Int_t errcode = 0;
00202    if (fParams) {
00203      Int_t thisSize = fParams->GetSize();
00204      for (Int_t i=0;i<thisSize;i++) {
00205         Bool_t bug = kFALSE;
00206         // Get header 
00207         table_head_st *h = GetHeader(i);
00208         TTable *table = GetTable(i);
00209         if (table) {
00210           assert(table->GetTableSize() == h->maxlen 
00211                 && table->GetRowSize() == h->rbytes
00212                 && table == (TTable *)h->dsl_pointer);
00213           table->SetNRows(h->nok);
00214           if (h->nok > h->maxlen){
00215              res = kFALSE; 
00216              errcode++;
00217              bug = kTRUE;
00218           }
00219           table->NaN();
00220           if (errcode && bug) {
00221           if (errcode == 1) 
00222                  fprintf(stderr,
00223                  "\n \t ***** module  <%s>  returned the corrupted table %s *****\n \t * The number of the used rows more (or equal) of the allocated ones *\n"
00224                                ,GetName(), table->GetName()); 
00225           const Char_t *suffix[4]={"st","nd","rd","th"};
00226           Int_t indx = i%10;
00227           if ( (10 < i && i < 20) || indx > 3 || indx == 0) indx = 4;
00228           indx--;
00229           const Char_t *name = names ? names[i] : "unknown" ;
00230           fprintf(stderr, "\t %i-%s <%s> %s has used %d with %d allocated\n"
00231           ,i+1,suffix[indx],name, table->GetName(),(int)h->nok,(int)h->maxlen);
00232         }
00233      }
00235    }
00236 }
00237    return res;
00238 }
00239 
00240 //______________________________________________________________________________
00241 Int_t St_Module::ExecuteModule()
00242 {
00243 
00244    Int_t errcode = 0;
00245    printf(" This \"%s\" module has ", GetName());
00246    if (fParams) 
00247    {
00248      Int_t thisSize = fParams->GetSize();
00249      if (thisSize == 1)
00250        printf("only one parameter: ");
00251      else
00252        printf("%i parameters: ",thisSize);
00253      for (Int_t i=0;i<thisSize;i++)
00254      {
00255         if (fParams->At(i)) printf(" %lx ",*((ULong_t *)fParams->At(i)));
00256         else { 
00257             errcode++; 
00258             //yf            Char_t *suffix[4]={"st","nd","d","th"};
00259             //yf            Bool_t istable = i & 1;
00260             printf("%i parameter has not been defined yet\n"
00261                    ,i+1);
00262         }
00263 
00264         if (i < thisSize-1) printf(", ");
00265      }
00266      printf("; \n");
00268    }
00269    else
00270     printf(" NO parameters \n");
00271    return errcode;
00272 }
00273 #if 0
00274 //______________________________________________________________________________
00275 void St_Module::SetEntryName()
00276 {
00277   st_Name = new char[strlen(GetName()+10];
00278   strcpy(st_Name,GetName());
00279   
00280   if (st_Name) 
00281   {
00282     if (st_Type==kFortran)
00283     {
00284 #ifdef U_CASE
00285       strupr(st_Name);
00286 # ifdef CERNLIB_MSSTDCALL
00287       char buftmp[10];
00288       strcat(st_Name,"@");
00289       atoi(buftmp,fN*4,10);   
00290       strcat(st_Name,buftmp);
00291 # endif  
00292 #else //VP if defined(uscope)
00293       strcat(st_Name,"_");
00294 #endif
00295      }
00296   }
00297   SetTitle(st_Name);
00298 }
00299 #endif
00300 //______________________________________________________________________________
00301 Int_t  St_Module::InvokeModule(TTable *f1,TTable *f2,TTable *f3,TTable *f4,
00302                               TTable *f5,TTable *f6,TTable *f7,TTable *f8,
00303                               TTable *f9,TTable *f10,TTable *f11,TTable *f12,
00304                               TTable *f13,TTable *f14,TTable *f15,TTable *f16,
00305                               TTable *f17,TTable *f18,TTable *f19,TTable *f20
00306                              ,TTable *f21,TTable *f22,TTable *f23,TTable *f24,
00307                               TTable *f25,TTable *f26,TTable *f27,TTable *f28,
00308                               TTable *f29,TTable *f30,TTable *f31,TTable *f32,
00309                               TTable *f33,TTable *f34,TTable *f35,TTable *f36,
00310                               TTable *f37,TTable *f38
00311                               )
00312 {
00313   fIndex = 38;
00314   SetAllParameters( f1, f2, f3, f4, f5, f6, f7, f8, f9,f10,f11,f12
00315                   ,f13,f14,f15,f16,f17,f18,f19,f20,f21,f22,f23,f24,
00316                   f25,f26,f27,f28,f29,f30,f31,f32,f33,f34,f35,f36,
00317                   f37,f38
00318                   );
00319   return ExecuteModule();
00320 }
00321 void St_Module::Streamer(TBuffer &)
00322 { assert(0);}
00323 
00324 //________________________________________________________________________
00325 // $Log: St_Module.cxx,v $
00326 // Revision 1.18  2003/04/30 20:39:12  perev
00327 // Warnings cleanup. Modified lines marked VP
00328 //
00329 // Revision 1.17  2001/07/16 23:58:35  fine
00330 // suppressing the compilation warning
00331 //
00332 // Revision 1.16  2000/09/15 15:12:37  perev
00333 // NaN check added
00334 //
00335 // Revision 1.15  2000/07/30 01:40:12  perev
00336 // StMem class added
00337 //
00338 // Revision 1.14  2000/03/30 05:20:51  fine
00339 // bug fixed
00340 //
00341 // Revision 1.13  2000/03/27 02:19:26  fine
00342 // warning removed
00343 //
00344 // Revision 1.12  2000/03/26 01:59:23  fine
00345 // new version of St_Module. Works for STAF module only
00346 //
00347 // Revision 1.11  2000/03/24 20:35:22  fine
00348 // adjusted to ROOT 2.24. Doesn't work yet. Under development
00349 //
00350 // Revision 1.10  1999/12/21 18:57:13  fine
00351 // compilation warning plus new type for SizeAttribute
00352 //
00353 // Revision 1.9  1999/12/07 22:26:26  fine
00354 // Clean up to remove the compilation warnings
00355 //
00356 // Revision 1.8  1999/06/14 09:45:41  fine
00357 // assert for St_Module (thanks Fisyak)
00358 //
00359 // Revision 1.7  1999/03/11 00:34:44  perev
00360 // St_base in new maker schema
00361 //
00362 // Revision 1.6  1999/02/24 17:10:57  fine
00363 //  St_Table  New and Purge method have been introdiced, some clean up for St_module as well
00364 //
00365 // Revision 1.5  1998/11/25 21:58:33  fisyak
00366 // Cleanup
00367 //
00368 // Revision 1.4  1998/08/25 23:07:24  didenko
00369 // New base with Tree
00370 //
00371 //________________________________________________________________________