GaudiTool.h

Go to the documentation of this file.

// $Id: GaudiTool.h,v 1.13 2008/10/10 13:38:28 marcocle Exp $
// ============================================================================
#ifndef GAUDIALG_GAUDITOOL_H
#define GAUDIALG_GAUDITOOL_H 1
// ============================================================================
// Include files
// ============================================================================
// GaudiKernel
// ============================================================================
#include "GaudiKernel/AlgTool.h"
#include "GaudiKernel/DataObject.h"
// ============================================================================
// GaudiAlg
// ============================================================================
#include "GaudiAlg/GaudiAlg.h"
#include "GaudiAlg/GaudiCommon.h"
// ============================================================================
// forward declarations
// ============================================================================
class          IDataProviderSvc ;
class          IChronoStatSvc   ;
class          IIncidentSvc     ;
class          IHistogramSvc    ;
class          GaudiException   ;
class          INTupleSvc       ;
class          IAlgContextSvc   ;
namespace std { class exception ; }
// ============================================================================
// ============================================================================
// ============================================================================
class GAUDI_API GaudiTool: public GaudiCommon<AlgTool>
{
public:
  // ==========================================================================
  virtual StatusCode    initialize ();
  virtual StatusCode    finalize   ();
  // ==========================================================================
public: // accessors
  // ==========================================================================
  INTupleSvc*          ntupleSvc () const;
  INTupleSvc*          evtColSvc () const;
  IDataProviderSvc*    detSvc    () const ;
  IDataProviderSvc*    evtSvc    () const ;
  IIncidentSvc*        incSvc    () const ;
  IChronoStatSvc*      chronoSvc () const ;
  IHistogramSvc*       histoSvc  () const ;
  IAlgContextSvc*     contextSvc () const ;
  // ==========================================================================
public:
  // ==========================================================================
  // following methods cannot go in GaudiCommon since they use methods ( evtSvc()
  // and detDvc() ) that are not members of AlgTool.
  // Also some methods seem which are members of the base class do not seem
  // to be found unless forwarding methods are put here ??
  // ==========================================================================

  inline DataObject* put ( IDataProviderSvc*  svc     ,
                    DataObject*        object  ,
                    const std::string& address ,
                    const bool useRootInTES = true ) const
  {
    return GaudiCommon<AlgTool>::put ( svc , object , address , useRootInTES ) ;
  }

  inline DataObject* put ( DataObject*        object   ,
                    const std::string& address  ,
                    const bool useRootInTES = true ) const
  {
    return GaudiCommon<AlgTool>::put ( evtSvc() , object , address , useRootInTES ) ;
  }

  template < class TYPE  >
  inline typename Gaudi::Utils::GetData<TYPE>::return_type
  get  (  IDataProviderSvc*  svc       ,
          const std::string& location  ,
          const bool useRootInTES = true ) const
  {
    return GaudiCommon<AlgTool>::get<TYPE> ( svc , location , useRootInTES ) ;
  }

  template < class TYPE  >
  inline typename Gaudi::Utils::GetData<TYPE>::return_type
  getIfExists ( IDataProviderSvc*  svc       ,
                const std::string& location  ,
                const bool useRootInTES = true ) const
  {
    return GaudiCommon<AlgTool>::getIfExists<TYPE> ( svc , location , useRootInTES ) ;
  }

  template < class TYPE  >
  inline typename Gaudi::Utils::GetData<TYPE>::return_type
  get  ( const std::string& location  ,
         const bool useRootInTES = true ) const
  {
    return GaudiCommon<AlgTool>::get<TYPE> ( evtSvc() , location , useRootInTES ) ;
  }

  template < class TYPE  >
  inline typename Gaudi::Utils::GetData<TYPE>::return_type
  getIfExists ( const std::string& location  ,
                const bool useRootInTES = true ) const
  {
    return GaudiCommon<AlgTool>::getIfExists<TYPE> ( evtSvc() , location , useRootInTES ) ;
  }

  template < class TYPE  >
  inline TYPE* getDet ( IDataProviderSvc*  svc        ,
                        const std::string& location   ) const
  {
    return GaudiCommon<AlgTool>::get<TYPE> ( svc , location , false ) ;
  }

  template < class TYPE  >
  inline typename Gaudi::Utils::GetData<TYPE>::return_type
  getDetIfExists ( IDataProviderSvc*  svc       ,
                   const std::string& location  ) const
  {
    return GaudiCommon<AlgTool>::getIfExists<TYPE> ( svc , location , false ) ;
  }

  template < class TYPE  >
  inline TYPE* getDet ( const std::string& location ) const
  {
    return GaudiCommon<AlgTool>::get<TYPE> ( detSvc() , location , false ) ;
  }

  template < class TYPE  >
  inline typename Gaudi::Utils::GetData<TYPE>::return_type
  getDetIfExists ( const std::string& location ) const
  {
    return GaudiCommon<AlgTool>::getIfExists<TYPE> ( detSvc() , location , false ) ;
  }

  template < class TYPE  >
  inline bool  exist    ( IDataProviderSvc*  svc      ,
                          const std::string& location ,
                          const bool useRootInTES = true ) const
  {
    return GaudiCommon<AlgTool>::exist<TYPE> ( svc , location , useRootInTES ) ;
  }

  template < class TYPE  >
  inline bool  exist    ( const std::string& location ,
                          const bool useRootInTES = true ) const
  {
    return GaudiCommon<AlgTool>::exist<TYPE> ( evtSvc() , location , useRootInTES ) ;
  }

  template < class TYPE  >
  inline bool  existDet    ( IDataProviderSvc*  svc      ,
                             const std::string& location ) const
  {
    return GaudiCommon<AlgTool>::exist<TYPE> ( svc , location , false ) ;
  }

  template < class TYPE  >
  inline bool  existDet    ( const std::string& location ) const
  {
    return GaudiCommon<AlgTool>::exist<TYPE> ( detSvc() , location , false ) ;
  }

  template < class TYPE , class TYPE2 >
  inline typename Gaudi::Utils::GetData<TYPE>::return_type
  getOrCreate ( IDataProviderSvc*  svc                 ,
                const std::string& location            ,
                const bool         useRootInTES = true ) const
  {
    return GaudiCommon<AlgTool>::getOrCreate<TYPE,TYPE2> ( svc , location , useRootInTES ) ;
  }

  template < class TYPE , class TYPE2 >
  inline typename Gaudi::Utils::GetData<TYPE>::return_type
  getOrCreate ( const std::string& location            ,
                const bool         useRootInTES = true ) const
  {
    return GaudiCommon<AlgTool>::getOrCreate<TYPE,TYPE2> ( evtSvc() , location , useRootInTES ) ;
  }

  // ==========================================================================
public:
  // ==========================================================================
  static bool enableSummary  ( bool ) ;               // enable/disable summary
  static bool summaryEnabled (      ) ;               // is summary enabled?
  // ==========================================================================
protected:
  // ==========================================================================
  GaudiTool ( const std::string& type   ,
              const std::string& name   ,
              const IInterface*  parent );

  virtual ~GaudiTool();
  // ==========================================================================
private:
  // ==========================================================================
  GaudiTool();
  GaudiTool             ( const GaudiTool& );
  GaudiTool& operator = ( const GaudiTool& );
  // ==========================================================================
private:
  // ==========================================================================
  mutable INTupleSvc*    m_ntupleSvc          ;
  mutable INTupleSvc*    m_evtColSvc          ;
  mutable IDataProviderSvc* m_evtSvc          ;
  mutable IDataProviderSvc* m_detSvc          ;
  mutable IChronoStatSvc*   m_chronoSvc       ;
  mutable IIncidentSvc*     m_incSvc          ;
  mutable IHistogramSvc *  m_histoSvc         ;
  // Pointer to the Algorithm Context Service
  mutable IAlgContextSvc* m_contextSvc     ; 
  // The name of the Algorithm Context Service
  std::string             m_contextSvcName ; 
  // ==========================================================================
private:
  // ==========================================================================
  const std::string m_local ;
  // ==========================================================================
private:
  // ==========================================================================
  static bool s_enableSummary ;  // enable printout of summary?
  // ==========================================================================
};
// ============================================================================

// ============================================================================
// The END
// ============================================================================
#endif  // GAUDIALG_GAUDITOOL_H
// ============================================================================