RootHistCnv::RFileCnv Class Reference

NTuple converter class definition. More...

#include <src/RFileCnv.h>

Inheritance diagram for RootHistCnv::RFileCnv:

Collaboration diagram for RootHistCnv::RFileCnv:

Public Member Functions
StatusCode	initialize () override
	Initialise. More...
StatusCode	createObj (IOpaqueAddress *pAddress, DataObject *&refpObject) override
	Create the transient representation of an object. More...
StatusCode	createRep (DataObject *pObject, IOpaqueAddress *&refpAddress) override
	Convert the transient object to the requested representation. More...
StatusCode	updateRep (IOpaqueAddress *pAddress, DataObject *pObject) override
	Convert the transient object to the requested representation. More...
	RFileCnv (ISvcLocator *svc)
	Standard constructor. More...
Public Member Functions inherited from RootHistCnv::RDirectoryCnv
StatusCode	createObj (IOpaqueAddress *pAddr, DataObject *&refpObj) override
	Create the transient representation of an object. More...
StatusCode	fillObjRefs (IOpaqueAddress *pAddr, DataObject *refpObj) override
	Update the transient object from the other representation. More...
StatusCode	createRep (DataObject *pObj, IOpaqueAddress *&refpAddr) override
	Convert the transient object to the requested representation. More...
StatusCode	updateRep (IOpaqueAddress *pAddr, DataObject *pObject) override
	Convert the transient object to the requested representation. More...
	RDirectoryCnv (ISvcLocator *svc)
	Standard constructor. More...
	RDirectoryCnv (ISvcLocator *svc, const CLID &clid)
	Standard constructor. More...
Public Member Functions inherited from RootHistCnv::RConverter
StatusCode	createRep (DataObject *pObj, IOpaqueAddress *&refpAddr) override
	Convert the transient object to the requested representation. More...
long	repSvcType () const override
StatusCode	error (const std::string &msg)
StatusCode	regTFile (const std::string, const TFile *)
StatusCode	findTFile (const std::string, TFile *&)
std::string	diskDirectory (const std::string &loc)
std::string	directory (const std::string &loc)
void	setDirectory (const std::string &loc)
void	setDiskDirectory (const std::string &loc)
StatusCode	createDirectory (const std::string &loc)
StatusCode	createDiskDirectory (const std::string &loc)
std::string	getDirectory ()
std::string	convertId (const std::string &) const
Public Member Functions inherited from Converter
StatusCode	initialize () override
	Initialize the converter. More...
StatusCode	finalize () override
	Initialize the converter. More...
StatusCode	setDataProvider (IDataProviderSvc *svc) override
	Set Data provider service. More...
SmartIF< IDataProviderSvc > &	dataProvider () const override
	Get Data provider service. More...
StatusCode	setConversionSvc (IConversionSvc *svc) override
	Set conversion service the converter is connected to. More...
SmartIF< IConversionSvc > &	conversionSvc () const override
	Get conversion service the converter is connected to. More...
StatusCode	setAddressCreator (IAddressCreator *creator) override
	Set address creator facility. More...
SmartIF< IAddressCreator > &	addressCreator () const override
	Retrieve address creator facility. More...
const CLID &	objType () const override
	Retrieve the class type of objects the converter produces. More...
virtual long	i_repSvcType () const
	Retrieve the class type of the data store the converter uses. More...
StatusCode	createObj (IOpaqueAddress *pAddress, DataObject *&refpObject) override
	Create the transient representation of an object. More...
StatusCode	fillObjRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Resolve the references of the created transient object. More...
StatusCode	updateObj (IOpaqueAddress *pAddress, DataObject *refpObject) override
	Update the transient object from the other representation. More...
StatusCode	updateObjRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Update the references of an updated transient object. More...
StatusCode	createRep (DataObject *pObject, IOpaqueAddress *&refpAddress) override
	Convert the transient object to the requested representation. More...
StatusCode	fillRepRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Resolve the references of the converted object. More...
StatusCode	updateRep (IOpaqueAddress *pAddress, DataObject *pObject) override
	Update the converted representation of a transient object. More...
StatusCode	updateRepRefs (IOpaqueAddress *pAddress, DataObject *pObject) override
	Update the references of an already converted object. More...
	Converter (long storage_type, const CLID &class_type, ISvcLocator *svc=0)
	Standard Constructor. More...
template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=false) const
	Access a service by name, creating it if it doesn't already exist. More...
template<class T >
StatusCode	service (const std::string &type, const std::string &name, T *&psvc) const
	Access a service by name, type creating it if it doesn't already exist. More...
SmartIF< IService >	service (const std::string &name, const bool createIf=true) const
	Return a pointer to the service identified by name (or "type/name") More...
Public Member Functions inherited from implements< IConverter >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...
	implements ()=default
	Default constructor. More...
	implements (const implements &)
	Copy constructor (zero the reference count) More...
implements &	operator= (const implements &)
	Assignment operator (do not touch the reference count). More...
unsigned long	addRef () override
	Reference Interface instance. More...
unsigned long	release () override
	Release Interface instance. More...
unsigned long	refCount () const override
	Current reference count. More...

Static Public Member Functions
static const CLID &	classID ()
	Inquire class type. More...
Static Public Member Functions inherited from RootHistCnv::RDirectoryCnv
static const CLID &	classID ()
	Inquire class type. More...
Static Public Member Functions inherited from RootHistCnv::RConverter
static long	storageType ()
	Inquire storage type. More...

Protected Attributes
TFile *	rfile {nullptr}
	Pointer to ROOT file. More...
std::string	m_compLevel
	Compression setting, property RFileCnv.GlobalCompression. More...
Protected Attributes inherited from implements< IConverter >
std::atomic_ulong	m_refCount
	Reference counter. More...

Additional Inherited Members
Public Types inherited from Converter
using	Factory = Gaudi::PluginService::Factory< IConverter *(ISvcLocator *)>
Public Types inherited from implements< IConverter >
using	base_class = implements< Interfaces... >
	Typedef to this class. More...
using	extend_interfaces_base = extend_interfaces< Interfaces... >
	Typedef to the base of this class. More...
using	iids = typename extend_interfaces_base::ext_iids
Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids... >::type
	take union of the ext_iids of all Interfaces... More...
Protected Member Functions inherited from RootHistCnv::RConverter
	RConverter (const CLID &clid, ISvcLocator *svc)
	Standard constructor. More...
virtual StatusCode	readObject (IOpaqueAddress *pAddr, DataObject *&refpObj)
	Create the transient representation of an object. More...
virtual TObject *	createPersistent (DataObject *pObj)
	Create the persistent representation of an object. More...
StatusCode	createAddress (DataObject *pObject, TDirectory *pDir, TObject *pTObject, IOpaqueAddress *&refpAddr)
	Create address of the transient object according to the requested representation. More...
StatusCode	createAddress (const std::string &rzdir, const CLID &clid, long id, TObject *pTobj, IOpaqueAddress *&refpAddress)
StatusCode	createAddress (const std::string &rzdir, const CLID &clid, const std::string &title, TObject *pTobj, IOpaqueAddress *&refpAddress)
TDirectory *	changeDirectory (DataObject *pObject)
	Switch to object directory (=Parent directory) More...
Protected Member Functions inherited from Converter
SmartIF< ISvcLocator > &	serviceLocator () const
	Retrieve pointer to service locator. More...
SmartIF< IMessageSvc > &	msgSvc () const
	Retrieve pointer to message service. More...
SmartIF< IDataManagerSvc > &	dataManager () const
	Get Data Manager service. More...

Detailed Description

NTuple converter class definition.

• Major cleanup and debugging for Gaudi v9
• Removal of all static storage

Author

Charles Leggett

Markus Frank

Definition at line 32 of file RFileCnv.h.

Constructor & Destructor Documentation

RFileCnv()

RootHistCnv::RFileCnv::RFileCnv

(

ISvcLocator *

svc

)

Standard constructor.

Definition at line 35 of file RFileCnv.cpp.

: RDirectoryCnv( svc, classID() ) {}

Member Function Documentation

classID()

static const CLID& RootHistCnv::RFileCnv::classID ( )

inlinestatic

Inquire class type.

Definition at line 48 of file RFileCnv.h.

{ return CLID_NTupleFile; }

createObj()

StatusCode RootHistCnv::RFileCnv::createObj ( IOpaqueAddress *  pAddress, DataObject *&  refpObject  )

override

Create the transient representation of an object.

Definition at line 51 of file RFileCnv.cpp.

{
  MsgStream      log( msgSvc(), "RFileCnv" );
  unsigned long* ipar    = (unsigned long*)pAddress->ipar();
  char           mode[2] = {char( ipar[1] ), 0};

  std::string fname  = pAddress->par()[0]; // Container name
  std::string ooname = pAddress->par()[1]; // Object name

  const std::string* spar = pAddress->par();
  // Strip of store name to get the top level RZ directory
  std::string oname = spar[1].substr( spar[1].find( "/", 1 ) + 1 );

  // Protect against multiple instances of TROOT
  if ( !gROOT ) {
    static TROOT root( "root", "ROOT I/O" );
    //    gDebug = 99;
  } else {
    log << MSG::VERBOSE << "ROOT already initialized, debug = " << gDebug << endmsg;
  }

  // Determine access mode:

  if ( mode[0] == 'O' ) {

    if ( findTFile( ooname, rfile ).isFailure() ) {

      log << MSG::INFO << "opening Root file \"" << fname << "\" for reading" << endmsg;

      rfile = TFile::Open( fname.c_str(), "READ" );
      if ( rfile && rfile->IsOpen() ) {
        regTFile( ooname, rfile ).ignore();

        ipar[0]             = (unsigned long)rfile;
        NTuple::File* pFile = new NTuple::File( objType(), fname, oname );
        pFile->setOpen( true );
        refpObject = pFile;

        return StatusCode::SUCCESS;

      } else {
        log << MSG::ERROR << "Couldn't open \"" << fname << "\" for reading" << endmsg;
        return StatusCode::FAILURE;
      }

    } else {
      log << MSG::DEBUG << "Root file \"" << fname << "\" already opened" << endmsg;
      return StatusCode::SUCCESS;
    }

  } else if ( mode[0] == 'U' ) {

    log << MSG::INFO << "opening Root file \"" << fname << "\" for updating" << endmsg;

    log << MSG::ERROR << "don't know how to do this yet. Aborting." << endmsg;
    exit( 1 );

  } else if ( mode[0] == 'N' ) {

    log << MSG::INFO << "opening Root file \"" << fname << "\" for writing";
    if ( !m_compLevel.empty() ) { log << ", CompressionLevel='" << m_compLevel << "'"; }
    log << endmsg;

    rfile = TFile::Open( fname.c_str(), "RECREATE", "Gaudi Trees" );
    if ( !( rfile && rfile->IsOpen() ) ) {
      log << MSG::ERROR << "Could not open file " << fname << " for writing" << endmsg;
      return StatusCode::FAILURE;
    }
    if ( !m_compLevel.empty() ) {
      const RootCompressionSettings settings( m_compLevel );
      rfile->SetCompressionSettings( settings.level() );
    }

    regTFile( ooname, rfile ).ignore();

    log << MSG::DEBUG << "creating ROOT file " << fname << endmsg;

    ipar[0]             = (unsigned long)rfile;
    NTuple::File* pFile = new NTuple::File( objType(), fname, oname );
    pFile->setOpen( true );
    refpObject = pFile;
    return StatusCode::SUCCESS;

  } else {

    log << MSG::ERROR << "Uknown mode to access ROOT file" << endmsg;
    return StatusCode::FAILURE;
  }

  return StatusCode::FAILURE;
}

createRep()

StatusCode RootHistCnv::RFileCnv::createRep ( DataObject *  pObject, IOpaqueAddress *&  refpAddress  )

override

Convert the transient object to the requested representation.

Definition at line 145 of file RFileCnv.cpp.

{
  refpAddress = pObject->registry()->address();
  return RFileCnv::updateRep( refpAddress, pObject );
}

initialize()

StatusCode RootHistCnv::RFileCnv::initialize ( )

override

Initialise.

Definition at line 38 of file RFileCnv.cpp.

                                           {
  // Set compression level property ...
  ISvcLocator* svcLoc = Gaudi::svcLocator();
  auto         jobSvc = svcLoc->service<IJobOptionsSvc>( "JobOptionsSvc" );
  auto         prop   = jobSvc->getClientProperty( "RFileCnv", "GlobalCompression" );
  if ( prop ) m_compLevel = prop->toString();

  // initialise base class
  return RDirectoryCnv::initialize();
}

updateRep()

StatusCode RootHistCnv::RFileCnv::updateRep ( IOpaqueAddress *  pAddress, DataObject *  pObject  )

override

Convert the transient object to the requested representation.

Definition at line 153 of file RFileCnv.cpp.

{
  MsgStream   log( msgSvc(), "RFileCnv" );
  std::string ooname = pAddress->par()[1];

  NTuple::File* pFile = dynamic_cast<NTuple::File*>( pObject );
  if ( pFile && pFile->isOpen() ) {

    unsigned long* ipar = (unsigned long*)pAddress->ipar();
    if ( findTFile( ooname, rfile ).isFailure() ) {
      log << MSG::ERROR << "Problems closing TFile " << ooname << endmsg;
      return StatusCode::FAILURE;
    }

    rfile->Write( nullptr, TObject::kOverwrite );
    if ( log.level() <= MSG::INFO ) {
      log << MSG::INFO << "dumping contents of " << ooname << endmsg;
      rfile->Print();
    }

    /*
     * MetaData
     * Ana Trisovic
     * March 2015
     * */
    SmartIF<IMetaDataSvc> mds;
    mds = serviceLocator()->service( "Gaudi::MetaDataSvc", false );
    // auto mds = service<IMetaDataSvc>("MetaDataSvc", false);
    if ( mds ) {
      std::map<std::string, std::string> m_metadata = mds->getMetaDataMap();
      if ( !rfile->WriteObject( &m_metadata, "info" ) ) { return StatusCode::FAILURE; }
    }
    /* */

    rfile->Close();
    delete rfile;

    ipar[0] = 0;
    pFile->setOpen( false );
    return StatusCode::SUCCESS;

  } else {
    log << MSG::ERROR << "TFile " << ooname << " is not open" << endmsg;
  }
  return StatusCode::FAILURE;
}

Member Data Documentation

m_compLevel

std::string RootHistCnv::RFileCnv::m_compLevel

protected

Compression setting, property RFileCnv.GlobalCompression.

Definition at line 55 of file RFileCnv.h.

rfile

TFile* RootHistCnv::RFileCnv::rfile {nullptr}

protected

Pointer to ROOT file.

Definition at line 54 of file RFileCnv.h.

---

The documentation for this class was generated from the following files:

• RootHistCnv/src/RFileCnv.h
• RootHistCnv/src/RFileCnv.cpp