UgliLoanPool.h

Go to the documentation of this file.

// $Id: UgliLoanPool.h,v 1.22 2009/05/18 14:59:06 kasahara Exp $
//
// UgliLoanPool
//
// UgliLoanPool is Singleton for managing the "active" Ugliii
//
// Author:  R. Hatcher 2000.05.15
//

#ifndef UgliLOANPOOL_H
#define UgliLOANPOOL_H

#include "Util/UtilMCFlag.h"
#include "UgliGeometry/Ugli.h"
#include "GeoGeometry/Geo.h"
#include "Configurable/CfgConfigurable.h"

class UgliGeomHandle;
class UgliGeometry;
class GeoGeometry;
class VldContext;
class VldRange;

#include "TObjArray.h"

class UgliLoanPool : public TObject, public CfgConfigurable {

   friend class UgliGeomHandle;  // need to call private GetUgliGeometry

 public:

   // setting this bypasses using the REROOT file info
   static void   SetAlwaysUseDbi(Bool_t flag = kTRUE);
   static Bool_t GetAlwaysUseDbi();

   static UgliLoanPool*    Instance();
   virtual void            Config();
   virtual const Registry& DefaultConfig() const;
   virtual void            SetConfigFromEnvironment();

   bool   DoesValidGeomExist(const VldContext& vldc,
                             Ugli::EModifyMode mmode = Ugli::kUseGlobal,
                             Geo::EAppType = Geo::kRecons);

   void   ClearPool(Bool_t frozen, Bool_t modifiable);
   bool   PurgeDbiTableCache() const;

   // Configure geometry to use alternative geometrical modeller
   void   SetUseGeo(Bool_t flag = kTRUE);
   bool   UseGeo() const { return fUseGeo; }

   // Configure to specify use of newer cavern modeling
   void SetUseNewCavern(Bool_t flag = kTRUE);
   bool GetUseNewCavern() const;
       
   // Configure to specify swim method in lo/hi field regions
   Geo::ESwimMethod GetSwimMethodLowField() const;
   Geo::ESwimMethod GetSwimMethodHighField() const;
   void   SetSwimMethodLowField(Geo::ESwimMethod swimmethod);
   void   SetSwimMethodHighField(Geo::ESwimMethod swimmethod);

   // Configure to specify medium associated with a given detector component
   void SetMedium(Geo::EDetComponent detcomp,const char* medName);
   const char* GetMedium(Geo::EDetComponent detcomp) const;

   // Configure geometry to turn off build of veto shield
   void SetShieldOff(Bool_t flag = kTRUE);
   bool GetShieldOff() const;
 
   // Set a medium specific process value
   void SetProcess(UtilMCFlag::EProcess process,Int_t processvalue,
                   const char* medname);
   // Set a medium specific cut value
   void SetCut(UtilMCFlag::ECut cut, Double_t cutvalue, const char* medname);
   // Set a medium specific tracking parameter value
   void SetTracking(UtilMCFlag::ETracking trk, Double_t trkvalue,
                    const char* medname);

   Registry GetMediumRegistry(const char* medName) const;
   
   //use Cfg:Int_t  GetMaxUnref() const { return fMaxUnref; }
   //use Cfg:void   SetMaxUnref(Int_t mx) { fMaxUnref = mx; }

   virtual void Print(Option_t *option = "") const;

 public:

   // to make this i/o-able we need a public default ctor
   UgliLoanPool();   // ctor - singleton class should make this private

   static void SaveToFile(const char* filename, bool recreate = true);
   static void ReadFromFile(const char* filename);

 private:

   UgliLoanPool(const UgliLoanPool &plp); // don't write this, but hide it
   virtual ~UgliLoanPool();

   // Helper class to handle deletion of singleton
   struct Cleaner {
      void ClassIsUsed() { }; // dummy method to keep compilers quiet
      ~Cleaner() {
         if (UgliLoanPool::fgInstance!=0) {
            delete UgliLoanPool::fgInstance;
            UgliLoanPool::fgInstance = 0;
         }
      }
   };
   friend struct Cleaner;

   // only UgliHandle should need call this ... and it is a "friend"
   UgliGeometry      *GetUgliGeometry(const VldContext& vldc, Bool_t frozen);
   UgliGeometry      *GetExistingUgliGeometry(const VldContext& vldc, Bool_t frozen);
   UgliGeometry      *BuildUgliGeometry(const VldContext& vldc, Bool_t frozen);

   GeoGeometry       *GetGeoGeometry(const VldContext& vldc, Bool_t frozen,
                                     Geo::EAppType apptype);
   GeoGeometry       *GetExistingGeoGeometry(const VldContext& vldc, 
                                         Bool_t frozen, Geo::EAppType apptype);
   GeoGeometry       *BuildGeoGeometry(const VldContext& vldc, Bool_t frozen,
                                       Geo::EAppType apptype);

   static UgliLoanPool *fgInstance;     // only copy of self

   // These structures are _owned_ by UgliLoanPool and it is responsible
   // for deleting them as necessary
   // Initially there will be just one, but later one could start
   // managing a more complex list

   TObjArray fFrozenUgliGeomList;     // UgliGeometry's from DB
   TObjArray fModifiableUgliGeomList; // UgliGeometry's that can be modifiable

   TObjArray fFrozenGeoGeomList;     // GeoGeometry's from DB
   TObjArray fModifiableGeoGeomList; // GeoGeometry's that can be modifiable

   Int_t     fMaxUnref;               // maximum unreferenced share geoms
   bool      fUseGeo; // config param to specify use of alternative GeoGeometry

   ClassDef(UgliLoanPool,2)

};
#endif // UGLILOANPOOL_H

---