GaudiTool.h

Go to the documentation of this file.

#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"
#include "GaudiKernel/DataObjectHandle.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:
  // ==========================================================================
  StatusCode    initialize () override;
  StatusCode    finalize   () override;
  // ==========================================================================
 public: // accessors
  // ==========================================================================
  INTupleSvc*          ntupleSvc () const;
  INTupleSvc*          evtColSvc () const;
  IDataProviderSvc*    detSvc    () 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:
  // ==========================================================================
  inline StatusCode Error
    ( const std::string& msg ,
      const StatusCode   st  = StatusCode::FAILURE ,
      const size_t       mx  = 10                  ) const
  {
    return GaudiCommon<AlgTool>::Error( m_isPublic ?
                                        msg + getCurrentAlgName() : msg,
                                        st, mx );
  }
  inline StatusCode Warning
    ( const std::string& msg ,
      const StatusCode   st  = StatusCode::FAILURE ,
      const size_t       mx  = 10                  ) const
  {
    return GaudiCommon<AlgTool>::Warning( m_isPublic ?
                                          msg + getCurrentAlgName() : msg,
                                          st, mx );
  }
  inline StatusCode Info
    ( const std::string& msg ,
      const StatusCode   st  = StatusCode::SUCCESS ,
      const size_t       mx  = 10                  ) const
  {
    return GaudiCommon<AlgTool>::Info( m_isPublic ?
                                       msg + getCurrentAlgName() : msg,
                                       st, mx );
  }
  // ==========================================================================
 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 );

  ~GaudiTool() override;
  // ==========================================================================
 private:
  // ==========================================================================
  GaudiTool() = delete;
  GaudiTool             ( const GaudiTool& ) = delete;
  GaudiTool& operator = ( const GaudiTool& ) = delete;
  // ==========================================================================
 private:
  // ==========================================================================
  bool isPublic() const;
  inline std::string getCurrentAlgName() const
  {
    const IAlgContextSvc * asvc    = this->contextSvc();
    const IAlgorithm     * current = ( asvc ? asvc->currentAlg() : NULL );
    return ( current ? " [" + current->name() + "]" : "" );
  }
  // ==========================================================================
 private:
  // ==========================================================================
  mutable INTupleSvc*    m_ntupleSvc = nullptr;
  mutable INTupleSvc*    m_evtColSvc = nullptr;
  mutable IDataProviderSvc* m_detSvc = nullptr;
  mutable IChronoStatSvc*   m_chronoSvc = nullptr;
  mutable IIncidentSvc*     m_incSvc = nullptr;
  mutable IHistogramSvc *  m_histoSvc = nullptr;
  // Pointer to the Algorithm Context Service
  mutable IAlgContextSvc* m_contextSvc = nullptr; 
  // The name of the Algorithm Context Service
  std::string             m_contextSvcName = "AlgContextSvc"; 
  // ==========================================================================
 private:
  // ==========================================================================
  bool m_isPublic = false;
  // ==========================================================================
 private:
  // ==========================================================================
  const std::string m_local ;
  // ==========================================================================
 private:
  // ==========================================================================
  static bool s_enableSummary ;  // enable printout of summary?
  // ==========================================================================

 public:
  using AlgTool::declareProperty;
  template <class T>
    Property* declareProperty
    ( const std::string& name,
      DataObjectHandle<T>&     hndl,
      const std::string& doc = "none" ) const
  {
    
    if ( hndl.mode() & Gaudi::DataHandle::Reader ) {      
      (const_cast<GaudiTool*>(this))->AlgTool::declareInput(&hndl);
    }
    
    if ( hndl.mode() & Gaudi::DataHandle::Writer ) {      
      (const_cast<GaudiTool*>(this))->AlgTool::declareOutput(&hndl);
    }
    
    if (hndl.owner() == 0) {
      hndl.setOwner((const_cast<GaudiTool*>(this)));
    }
    
    return m_propertyMgr->declareProperty(name, hndl, doc);
  }


};
// ============================================================================

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