AlgFactory.cxx

Go to the documentation of this file.

// $Id: AlgFactory.cxx,v 1.30 2005/04/13 22:04:10 gmieg Exp $
//
// AlgFactory.cxx
//
// AlgFactory creates Algorithm objects derived from AlgBase.
//
// Author:  G. Irwin 2/2000

#include <cassert>

#include "TROOT.h"
#include "TString.h"
#include "TSystem.h"

#include "Algorithm/AlgConfig.h"
#include "Algorithm/AlgBase.h"
#include "Algorithm/AlgFactory.h"
#include "Algorithm/ConfigRecord.h"
#include "DatabaseInterface/DbiConfigSet.h"
#include "DatabaseInterface/DbiConfigStream.h"
#include "DynamicFactory/DynAlgReg.h"
#include "DynamicFactory/DynamicPluggableFactory.h"
#include "JobControl/JobController.h"
#include "MessageService/MsgService.h"

ClassImp(AlgFactory)

//......................................................................
CVSID("$Id: AlgFactory.cxx,v 1.30 2005/04/13 22:04:10 gmieg Exp $");

// Define static variables.  They get initialized to zero by default.
   AlgFactory *AlgFactory::fsTheInstance;

//______________________________________________________________________
AlgFactory::AlgFactory() :
  fConfigRecordIsModified(kFALSE)
{
   MSG("Alg", Msg::kDebug) << "AlgFactory::Constructor\n";
   fsTheInstance = this;
}

//______________________________________________________________________
AlgFactory::~AlgFactory()
{
   MSG("Alg", Msg::kDebug) << "AlgFactory::Destructor\n";
   fAlgHandleList.Delete();
   fsTheInstance = 0;
}

//______________________________________________________________________
AlgFactory &AlgFactory::GetInstance()
{

// Cleaner destructor calls AlgFactory dtor
   static Cleaner cleaner;

   if (!fsTheInstance) {
     MSG("Alg", Msg::kDebug) << "Instantiating AlgFactory " << endl;
     cleaner.UseMe();           // dummy call to quiet compiler warnings
     fsTheInstance = new AlgFactory();
   }
   return *fsTheInstance;
}

//______________________________________________________________________
AlgHandle AlgFactory::GetAlgHandle(const char *aalgnm,
                                   const char *ccnfnm)
{
   const char *algnm = Strip(aalgnm);
   const char *cnfnm = Strip(ccnfnm);

   TString regstr(algnm);
   regstr = regstr + ":" + cnfnm;
   AlgHandle *ah = (AlgHandle *)
                               fAlgHandleList.FindObject(regstr.Data());

   if (ah) {
     delete [] algnm;  delete [] cnfnm;  // Strip() gives user ownership
     return *ah;
   }

   DynamicPluggableFactory &dpf =
                                 DynamicPluggableFactory::GetInstance();

   Bool_t ljreg = kFALSE;
   if ((ljreg = !dpf.IsRegistered(regstr.Data())))
                                                 Register(algnm, cnfnm);
   AlgBase &ab = dpf.LendAlg(algnm);
   AlgConfig &ac = dpf.LendAlgConfig(regstr.Data());
   TRef acr = &ac;
   ah = new AlgHandle(&ab, acr);

   ah->SetName(regstr.Data());
   fAlgHandleList.Add(ah);

   fConfigRecordIsModified = kTRUE;

   if (ljreg) {
     TString macroname("DBtxt_");
     macroname = macroname + algnm + "_" + cnfnm + ".C";
     char *mac = gSystem->Which(gROOT->GetMacroPath(), macroname,
                                                       kReadPermission);
     if (mac) {
       MSG("Alg", Msg::kInfo)
                    << "AlgFactory:  (AlgorithmClass:AlgConfigName) = ("
           << regstr.Data() << ") parameters set from ROOT macro file: "
                                                         << mac << endl;
       gROOT->Macro(macroname.Data());
     }

     else {            // Get the AlgConfig parameters from the database

// Here one tries to fill AlgConfig from database.
       DbiConfigStream cfstream(algnm,cnfnm);
       const DbiConfigSet *cfset = cfstream.GetConfigSet();
       if (cfset) {
         cfstream >> &ac;            // Get AlgConfig parameters from DB
         MSG("Alg", Msg::kInfo)
                    << "AlgFactory:  (AlgorithmClass:AlgConfigName) = ("
            << regstr.Data() << ") parameters set from DB table entry: "
                                       << algnm << "," << cnfnm << endl;
       }
       else {                               // AlgConfig table not in DB

// The messages below are printed if the attempt fails.
         MSG("Alg", Msg::kError)
                    << "AlgFactory:  (AlgorithmClass:AlgConfigName) = ("
              << regstr.Data() << ") - failed to find ROOT macro file: "
                << macroname << " in " << gROOT->GetMacroPath() << endl;
         MSG("Alg", Msg::kError)
                    << "AlgFactory:  (AlgorithmClass:AlgConfigName) = ("
           << regstr.Data() << ") parameters not available in database."
                             << "  This is likely to be fatal." << endl;
       }
     }
     delete [] mac;      // TSystem::Which() gives ownership to the user
   }

   delete [] algnm;  delete [] cnfnm; // Strip() gives ownership to user
   return *ah;
}

//______________________________________________________________________
ConfigRecord *AlgFactory::GetOwnedConfigRecord(const VldContext *vld)
{

// Only returns a ConfigRecord when the AlgConfig list has been modified
   if (fConfigRecordIsModified == kFALSE) return 0;

// Create new ConfigRecord for owned return to caller.
   const RecHeader rh(*vld);
   ConfigRecord *confrec = new ConfigRecord(rh);
   confrec->HasBeenModified();
   confrec->SetTransient(false);// Record not to be cleared by mom.clear
   confrec->SetName("AlgConfigRecord");
   confrec->SetTitle("Created by AlgFactory");

// Add AlgConfigs to new ConfigRecord
   TIter algiter(&fAlgHandleList);
   AlgHandle *ah = 0;
   while ((ah = (AlgHandle *) algiter())) {
     confrec->SecureConfig(ah->GetAlgConfig());
   }

   fConfigRecordIsModified = kFALSE;
   return confrec;
}

//______________________________________________________________________
void AlgFactory::Register(const char *aalgnm, const char *ccnfnm,
                          const char *libnm,  const char *cclnm)
{
   const char *algnm = Strip(aalgnm);
   const char *cnfnm = Strip(ccnfnm);

   TString cclstr(cclnm ? cclnm : "AlgConfig");
   TString regstr(algnm);
   regstr = regstr + ":" + cnfnm;
   DynamicPluggableFactory &dpf =
                                 DynamicPluggableFactory::GetInstance();
   if (dpf.IsRegistered(regstr.Data())) {
     MSG("Alg", Msg::kWarning)
       << "AlgFactory:  (AlgorithmClass:AlgConfigName) = ("
       << regstr.Data() << ") already registered.  2nd attempt Ignored."
       << endl;
     delete [] algnm;  delete [] cnfnm;  // Strip() gives user ownership
     return;
   }

   DynAlgReg *dar = new DynAlgReg(regstr.Data(), algnm, libnm,
                                  cclstr.Data());
   dpf.Register(dar);

   MSG("Alg", Msg::kDebug)
    << "AlgFactory:  Registration of (AlgorithmClass:AlgConfigName) = ("
    << regstr.Data() << ") completed." << endl;

   delete [] algnm;  delete [] cnfnm;    // Strip() gives user ownership
   return;
}

---