HLT/BASE/AliHLTMisc.h

   1 //-*- Mode: C++ -*-
   2 // $Id$
   3
   4 #ifndef ALIHLTMISC_H
   5 #define ALIHLTMISC_H
   6 //* This file is property of and copyright by the ALICE HLT Project        *
   7 //* ALICE Experiment at CERN, All rights reserved.                         *
   8 //* See cxx source for full Copyright notice                               */
   9
  10 /// @file   AliHLTMisc.h
  11 /// @author Matthias Richter
  12 /// @date
  13 /// @brief  Definition of various glue functions implemented in dynamically
  14 ///         loaded libraries
  15
  16 #include "TObject.h"
  17 #include "AliHLTStdIncludes.h"
  18 #include "AliHLTDataTypes.h"
  19 #include "AliHLTLogging.h"
  20 #include "TClass.h"
  21 #include "TSystem.h"
  22
  23 class AliCDBManager;
  24 class AliCDBEntry;
  25 class AliRawReader;
  26 class AliHLTComponentDataType;
  27 class AliHLTGlobalTriggerDecision;
  28 class TMap;
  29
  30 class AliHLTMisc : public TObject {
  31  public:
  32   AliHLTMisc();
  33   ~AliHLTMisc();
  34
  35   template<class T>
  36   static T* LoadInstance(const T* dummy, const char* classname, const char* library=NULL);
  37
  38   static AliHLTMisc& Instance();
  39
  40   virtual int InitCDB(const char* cdbpath);
  41
  42   virtual int SetCDBRunNo(int runNo);
  43   virtual int GetCDBRunNo() const;
  44
  45   /// Load an OCDB object
  46   virtual AliCDBEntry* LoadOCDBEntry(const char* path, int runNo=-1, int version = -1, int subVersion = -1) const;
  47
  48   // Extract the TObject instance from the CDB object
  49   virtual TObject* ExtractObject(AliCDBEntry* entry) const;
  50
  51   /// check the availability of the OCDB entry descriptions in the TMap
  52   ///  key : complete OCDB path of the entry
  53   ///  value : auxiliary object - short description
  54   virtual int CheckOCDBEntries(const TMap* const pMap) const;
  55
  56   virtual int InitMagneticField() const;
  57
  58   virtual AliHLTUInt64_t GetTriggerMask(AliRawReader* rawReader) const;
  59
  60   virtual AliHLTUInt32_t GetTimeStamp(AliRawReader* rawReader) const;
  61   virtual AliHLTUInt32_t GetEventType(AliRawReader* rawReader) const;
  62
  63   virtual Double_t GetBz();
  64   virtual Double_t GetBz(const Double_t *r);
  65   virtual void GetBxByBz(const Double_t r[3], Double_t b[3]);
  66
  67   virtual const TClass* IsAliESDHLTDecision() const;
  68   virtual int Copy(const AliHLTGlobalTriggerDecision* pDecision, TObject* pESDHLTDecision) const;
  69
  70   /// Init streamer info from ocdb entry
  71   virtual int InitStreamerInfos(const char* ocdbEntry) const;
  72
  73   /// Init streamer info for a collection of classes
  74   virtual int InitStreamerInfos(TObjArray* pSchemas) const;
  75
  76  private:
  77   static AliHLTMisc* fgInstance;
  78
  79   ClassDef(AliHLTMisc, 0)
  80 };
  81
  82 #define ALIHLTMISC_LIBRARY "libHLTrec.so"
  83 #define ALIHLTMISC_INIT_CDB "AliHLTMiscInitCDB"
  84 #define ALIHLTMISC_SET_CDB_RUNNO "AliHLTMiscSetCDBRunNo"
  85
  86 #ifdef __cplusplus
  87 extern "C" {
  88 #endif
  89
  90   /**
  91    * Init the CDB access for the running instance.
  92    * The method is used from the C wrapper interface utilized by the  on-line
  93    * framework. The path of the (H)CDB is set to the specified path.<br>
  94    * When running from AliRoot, the CDB path is set in the startup of the
  95    * reconstruction.<br>
  96    * If cdbpath is nil or empty and the CDB is not already initialized, the
  97    * CDB storage is set to local://$ALICE_ROOT/OCDB and the run no to 0.
  98    * @param cdbpath     path to the CDB
  99    * @return neg. error code if failed
 100    * @note function implemented in libHLTrec
 101    */
 102   int AliHLTMiscInitCDB(const char* cdbpath);
 103   typedef int (*AliHLTMiscInitCDB_t)(const char* cdbpath);
 104
 105   /**
 106    * Init the Run no for the CDB access.
 107    * @param runNo       the run no
 108    * @return neg. error code if failed
 109    * @note function implemented in libHLTrec
 110    */
 111   int AliHLTMiscSetCDBRunNo(int runNo);
 112   typedef int (*AliHLTMiscSetCDBRunNo_t)(int runNo);
 113
 114 #ifdef __cplusplus
 115 }
 116 #endif
 117
 118 template<class T>
 119 T* AliHLTMisc::LoadInstance(const T* /*t*/, const char* classname, const char* library)
 120 {
 121   // see header file for function documentation
 122   int iLibResult=0;
 123   T* pInstance=NULL;
 124   AliHLTLogging log;
 125   TClass* pCl=NULL;
 126   ROOT::NewFunc_t pNewFunc=NULL;
 127   do {
 128     pCl=TClass::GetClass(classname);
 129   } while (!pCl && library!=NULL && (iLibResult=gSystem->Load(library))==0);
 130   if (iLibResult>=0) {
 131     if (pCl && (pNewFunc=pCl->GetNew())!=NULL) {
 132       void* p=(*pNewFunc)(NULL);
 133       if (p) {
 134         pInstance=reinterpret_cast<T*>(p);
 135         if (!pInstance) {
 136           log.Logging(kHLTLogError, "AliHLTMisc::LoadInstance", "HLT Analysis", "type cast (%s) to instance failed", classname);
 137         }
 138       } else {
 139         log.Logging(kHLTLogError, "AliHLTMisc::LoadInstance", "HLT Analysis", "can not create instance of type %s from class descriptor", classname);
 140       }
 141     } else {
 142       log.Logging(kHLTLogError, "AliHLTMisc::LoadInstance", "HLT Analysis", "can not find TClass descriptor %s", classname);
 143     }
 144   } else {
 145     log.Logging(kHLTLogError, "AliHLTMisc::LoadInstance", "HLT Analysis", "can not load %s library in order to find class descriptor %s", library, classname);
 146   }
 147   return pInstance;
 148 }
 149
 150 // direct printout of data type struct
 151 ostream  &operator<<(ostream &str, const AliHLTComponentDataType&);
 152
 153 #endif //ALIHLTMISC_H