RootCnvSvc.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2025 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
//====================================================================
//  RootCnvSvc definition
//--------------------------------------------------------------------
//
//  Author     : M.Frank
//====================================================================
#pragma once
 
// Framework include files
#include <GaudiKernel/ClassID.h>
#include <GaudiKernel/ConversionSvc.h>
#include <GaudiKernel/DataObject.h>
#include <GaudiUtils/IIODataManager.h>
 
// C++ include files
#include <set>
 
// Forward declarations
struct IDataManagerSvc;
class IIncidentSvc;
class TClass;
 
// ROOT include files
#include <TBranch.h>
#include <TClass.h>
#include <TROOT.h>
#include <TTree.h>
 
// #include "RootCnv/RootPerfMonSvc.h"
 
/*
 * Gaudi namespace declaration
 */
namespace Gaudi {
 
  // Forward declarations
  class IDataConnection;
  class RootDataConnection;
  class RootConnectionSetup;
 
  class GAUDI_API RootCnvSvc : public ConversionSvc {
  protected:
    Gaudi::Property<std::string> m_ioPerfStats{
        this, "IOPerfStats", "", "Enable TTree IOperfStats if not empty; otherwise perf stat file name" };
    Gaudi::Property<std::string> m_shareFiles{ this, "ShareFiles", "NO",
                                               "Share files? If set to YES,  files will not be closed on finalize" };
    Gaudi::Property<bool> m_incidentEnabled{ this, "EnableIncident", true, "Flag to enable incidents on FILE_OPEN" };
    Gaudi::Property<std::string> m_recordName{ this, "RecordsName", "/FileRecords",
                                               "Records name to fire incident for file records" };
 
    // ROOT Write parameters
    Gaudi::Property<int> m_minBufferSize{ this, "MinBufferSize", 2 * 1024 /*kBYTE*/,
                                          "Minimum buffer size to use for writing TTree baskets" };
    Gaudi::Property<int> m_maxBufferSize{ this, "MaxBufferSize", 100 * 1024 * 1024 /*MBYTE*/,
                                          "Maximum buffer size to use for writing TTree baskets" };
    Gaudi::Property<int> m_approxEventsPerBasket{ this, "ApproxEventsPerBasket", 1000,
                                                  "Resize TBasket buffers to fit approximately this many events" };
    Gaudi::Property<int> m_splitLevel{ this, "SplitLevel", 0, "Split level optimization parameter for ROOT TTree" };
    Gaudi::Property<std::string> m_compression{ this, "GlobalCompression", "",
                                                "Compression-algorithm:compression-level,  empty: do nothing" };
 
    SmartIF<Gaudi::IIODataManager> m_ioMgr;
    SmartIF<IIncidentSvc> m_incidentSvc;
    Gaudi::RootDataConnection* m_current = nullptr;
    TClass* m_classRefs = nullptr;
    TClass* m_classDO = nullptr;
    std::shared_ptr<RootConnectionSetup> m_setup;
    std::string m_currSection;
 
    std::set<std::string> m_badFiles;
 
    std::unique_ptr<MsgStream> m_log;
 
    TClass* getClass( DataObject* pObject );
    MsgStream& log() const { return *m_log; }
 
  public:
    RootCnvSvc( const std::string& name, ISvcLocator* svc );
 
    StatusCode updateServiceState( IOpaqueAddress* /* pAddress */ ) override { return StatusCode::SUCCESS; }
 
    StatusCode error( const std::string& msg );
 
    StatusCode connectDatabase( const std::string& dataset, int mode, RootDataConnection** con );
 
    StatusCode initialize() override;
 
    StatusCode finalize() override;
 
    IConverter* createConverter( long typ, const CLID& wanted, const ICnvFactory* fac ) override;
 
    void loadConverter( DataObject* pObj ) override;
 
    StatusCode connectOutput( const std::string& outputFile, const std::string& openMode ) override;
 
    StatusCode connectOutput( const std::string& outputFile ) override;
 
    StatusCode commitOutput( const std::string& outputFile, bool do_commit ) override;
 
    virtual StatusCode disconnect( const std::string& dbName );
 
    StatusCode createAddress( long svc_type, const CLID& clid, const std::string* par, const unsigned long* ip,
                              IOpaqueAddress*& refpAddress ) override;
 
    StatusCode createAddress( long svc_type, const CLID& clid, const std::string& refAddress,
                              IOpaqueAddress*& refpAddress ) override {
      return this->ConversionSvc::createAddress( svc_type, clid, refAddress, refpAddress );
    }
 
    virtual StatusCode createNullRep( const std::string& path );
 
    virtual StatusCode createNullRef( const std::string& path );
 
    virtual StatusCode i__createRep( DataObject* pObj, IOpaqueAddress*& refpAddr );
 
    virtual StatusCode i__fillRepRefs( IOpaqueAddress* pAddr, DataObject* pObj );
 
    virtual StatusCode i__createObj( IOpaqueAddress* pAddr, DataObject*& refpObj );
 
    virtual StatusCode i__fillObjRefs( IOpaqueAddress* pAddr, DataObject* pObj );
  };
} // namespace Gaudi