NTuple converter class definition. More...

#include <src/RNTupleCnv.h>

Inheritance diagram for RootHistCnv::RNTupleCnv:

[legend]

Collaboration diagram for RootHistCnv::RNTupleCnv:

[legend]

Public Member Functions
StatusCode	initialize () override
	Initialize the converter. More...

StatusCode	finalize () override
	Finalize the converter. More...

StatusCode	createObj (IOpaqueAddress pAddr, DataObject &refpObj) override
	Create the transient representation of an object. More...

StatusCode	updateObj (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 pObj) override
	Update the converted representation of a transient object. 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...

Protected Member Functions
	RNTupleCnv (ISvcLocator *svc, const CLID &clid)
	Standard constructor. More...

virtual StatusCode	load (TTree tree, INTuple &refpObj)=0
	Create the transient representation of an object. More...

virtual StatusCode	book (const std::string &desc, INTuple pObj, TTree &tree)=0
	Book a new N tuple. More...

virtual StatusCode	writeData (TTree rtree, INTuple pObj)=0
	Write N tuple data. More...

virtual StatusCode	readData (TTree rtree, INTuple pObj, long ievt)=0
	Read N tuple data. More...

virtual std::string	rootVarType (int)
	Return ROOT type info: 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...

Protected Attributes
SmartIF< INTupleSvc >	m_ntupleSvc
	Reference to N tuple service. 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...

Static Public Member Functions inherited from RootHistCnv::RConverter
static long	storageType ()
	Inquire storage type. More...

Detailed Description

NTuple converter class definition.

Package : RootHistCnv Author : Charles Leggett

Definition at line 33 of file RNTupleCnv.h.

Constructor & Destructor Documentation

◆ RNTupleCnv()

RootHistCnv::RNTupleCnv::RNTupleCnv	(	ISvcLocator *	svc,
		const CLID &	clid
	)

protected

Standard constructor.

Definition at line 44 of file RNTupleCnv.cpp.

44 : RConverter( clid, svc ) {}

RootHistCnv::RConverter::RConverter

RConverter(const CLID &clid, ISvcLocator *svc)

Standard constructor.

Definition: RConverter.h:65

Member Function Documentation

◆ book()

virtual StatusCode RootHistCnv::RNTupleCnv::book	(	const std::string &	desc,
		INTuple *	pObj,
		TTree *&	tree
	)

protectedpure virtual

Book a new N tuple.

Implemented in RootHistCnv::RCWNTupleCnv, and RootHistCnv::RRWNTupleCnv.

◆ createObj()

StatusCode RootHistCnv::RNTupleCnv::createObj	(	IOpaqueAddress *	pAddr,
		DataObject *&	refpObj
	)

override

Create the transient representation of an object.

Definition at line 95 of file RNTupleCnv.cpp.

 {
   MsgStream log( msgSvc(), "RNTupleCnv" );
 
   IRegistry* pReg = pAddress->registry();
 
   //    log << MSG::WARNING << "adr: " << pAddress->par()[0] << " <> "
   //        << pAddress->par()[1] << " <> " << pAddress->ipar()[0] << " <> "
   //        << pAddress->ipar()[1] << " <> " << hex << rAddr->tObj()
   //        << dec << " <> " << pReg->identifier() << endmsg;
 
   std::string ident = pReg->identifier();
 
   StatusCode status = readObject( pAddress, refpObject ); // Doesn't do anything
   if ( status.isSuccess() ) {
     RootObjAddress* rAddr = dynamic_cast<RootObjAddress*>( pAddress );
     if ( !rAddr ) {
       log << MSG::ERROR << "Could not cast to RootObjAddress" << endmsg;
       return StatusCode::FAILURE;
     }
     INTuple* nt   = nullptr;
     TTree*   tobj = (TTree*)rAddr->tObj();
     status        = load( tobj, nt );
     if ( status.isSuccess() ) {
       refpObject = dynamic_cast<DataObject*>( nt );
     } else {
       log << MSG::ERROR << "Problems loading ntuple id: " << pReg->identifier() << endmsg;
     }
   }
   return status;
 }

◆ createRep()

StatusCode RootHistCnv::RNTupleCnv::createRep	(	DataObject *	pObj,
		IOpaqueAddress *&	refpAddr
	)

override

Convert the transient object to the requested representation.

Definition at line 130 of file RNTupleCnv.cpp.

 {
   GlobalDirectoryRestore restore;
   pAddr = nullptr;
   try {
     IRegistry* pReg = pObject->registry();
     if ( pReg ) {
       pAddr = pReg->address();
       if ( !pAddr ) {
         auto dataMgr = dataProvider().as<IDataManagerSvc>();
         if ( dataMgr ) {
           IRegistry* pParentReg = nullptr;
           StatusCode status     = dataMgr->objectParent( pReg, pParentReg );
           if ( status.isSuccess() ) {
             IOpaqueAddress* pParAddr = pParentReg->address();
             if ( pParAddr ) {
               TDirectory* pParentDir = (TDirectory*)pParAddr->ipar()[0];
               if ( pParentDir ) {
                 TTree* pTree = nullptr;
                 auto   dsc   = pReg->name().substr( 1 );
                 gDirectory   = pParentDir;
                 status       = book( dsc, dynamic_cast<INTuple*>( pObject ), pTree );
                 if ( !status.isSuccess() ) { return status; }
                 status = createAddress( pObject, gDirectory, pTree, pAddr );
                 if ( !status.isSuccess() ) { return status; }
                 return writeData( pTree, dynamic_cast<INTuple*>( pObject ) );
               }
             }
           }
         }
       } else {
         TDirectory*     pDir  = (TDirectory*)pAddr->ipar()[0];
         RootObjAddress* rAddr = dynamic_cast<RootObjAddress*>( pAddr );
         if ( !rAddr ) {
           MsgStream log( msgSvc(), "RNTupleCnv" );
           log << MSG::ERROR << "Could not cast to RootObjAddress" << endmsg;
           return StatusCode::FAILURE;
         }
         TTree* pTree = (TTree*)rAddr->tObj();
         gDirectory   = pDir;
         return writeData( pTree, dynamic_cast<INTuple*>( pObject ) );
       }
     }
   } catch ( ... ) {}
   MsgStream log( msgSvc(), "RNTupleCnv" );
   log << MSG::ERROR << "Failed to create persistent N-tuple!" << endmsg;
   return StatusCode::FAILURE;
 }

◆ finalize()

StatusCode RootHistCnv::RNTupleCnv::finalize ( )

override

Finalize the converter.

Definition at line 61 of file RNTupleCnv.cpp.

                                            {
   //-----------------------------------------------------------------------------
   m_ntupleSvc.reset();
   return Converter::finalize();
 }

◆ initialize()

StatusCode RootHistCnv::RNTupleCnv::initialize ( )

override

Initialize the converter.

Definition at line 49 of file RNTupleCnv.cpp.

                                              {
   //-----------------------------------------------------------------------------
   StatusCode status = Converter::initialize();
   if ( status.isSuccess() ) {
     m_ntupleSvc = serviceLocator()->service( "NTupleSvc" );
     if ( !m_ntupleSvc ) status = StatusCode::FAILURE;
   }
   return status;
 }

◆ load()

virtual StatusCode RootHistCnv::RNTupleCnv::load	(	TTree *	tree,
		INTuple *&	refpObj
	)

protectedpure virtual

Create the transient representation of an object.

Implemented in RootHistCnv::RCWNTupleCnv, and RootHistCnv::RRWNTupleCnv.

◆ readData()

virtual StatusCode RootHistCnv::RNTupleCnv::readData	(	TTree *	rtree,
		INTuple *	pObj,
		long	ievt
	)

protectedpure virtual

Read N tuple data.

Implemented in RootHistCnv::RCWNTupleCnv, and RootHistCnv::RRWNTupleCnv.

◆ rootVarType()

std::string RootHistCnv::RNTupleCnv::rootVarType ( int type )

protectedvirtual

Return ROOT type info:

Definition at line 210 of file RNTupleCnv.cpp.

                                                        {
   //-----------------------------------------------------------------------------
   switch ( type ) {
   case DataTypeInfo::BOOL:
     return "/O"; // bool
   case DataTypeInfo::SHORT:
     return "/S"; // short
   case DataTypeInfo::INT:
     return "/I"; // int
   case DataTypeInfo::LONG:
     return "/I"; // long
   case DataTypeInfo::LONGLONG:
     return "/L"; // long long
   case DataTypeInfo::USHORT:
     return "/s"; // ushort
   case DataTypeInfo::UINT:
     return "/i"; // uint
   case DataTypeInfo::ULONG:
     return "/i"; // ulong
   case DataTypeInfo::ULONGLONG:
     return "/l"; // unsigned long long
   case DataTypeInfo::FLOAT:
     return "/F"; // float
   case DataTypeInfo::DOUBLE:
     return "/D"; // double
   case DataTypeInfo::CHAR:
     return "/B"; // char
   case DataTypeInfo::UCHAR:
     return "/b"; // char
   default:
     return "";
   }
   // cannot reach this point
 }

◆ updateObj()

StatusCode RootHistCnv::RNTupleCnv::updateObj	(	IOpaqueAddress *	pAddr,
		DataObject *	refpObj
	)

override

Update the transient object from the other representation.

Definition at line 69 of file RNTupleCnv.cpp.

 {
   MsgStream log( msgSvc(), "RNTupleCnv" );
 
   StatusCode status = StatusCode::FAILURE;
 
   RootObjAddress* rAddr = dynamic_cast<RootObjAddress*>( pAddress );
 
   if ( !rAddr ) {
     log << MSG::ERROR << "Could not dynamic cast to RootObjAddress" << endmsg;
     return StatusCode::FAILURE;
   }
 
   TTree* rtree = (TTree*)rAddr->tObj();
 
   try {
     unsigned long* info = (unsigned long*)pAddress->ipar();
     setDirectory( pAddress->par()[0] );
     status = readData( rtree, dynamic_cast<INTuple*>( pObject ), info[1]++ );
   } catch ( ... ) {}
   return status;
 }

◆ updateRep()

StatusCode RootHistCnv::RNTupleCnv::updateRep	(	IOpaqueAddress *	pAddr,
		DataObject *	pObj
	)

override

Update the converted representation of a transient object.

Definition at line 182 of file RNTupleCnv.cpp.

 {
   MsgStream log( msgSvc(), "RNTupleCnv" );
   if ( pAddr ) {
     GlobalDirectoryRestore restore;
     TDirectory*            pDir  = (TDirectory*)pAddr->ipar()[0];
     RootObjAddress*        rAddr = dynamic_cast<RootObjAddress*>( pAddr );
     if ( !rAddr ) {
       log << MSG::ERROR << "Could not cast to RootObjAddress" << endmsg;
       return StatusCode::FAILURE;
     }
     TTree* pTree = (TTree*)rAddr->tObj();
     if ( pDir && pTree ) {
       gDirectory->cd( pDir->GetPath() );
       pTree->Write( "", TObject::kOverwrite );
       return StatusCode::SUCCESS;
     }
   } else {
     log << MSG::WARNING << "empty ntuple: " << pObj->registry()->identifier() << endmsg;
     return createRep( pObj, pAddr );
   }
   return StatusCode::FAILURE;
 }

◆ writeData()

virtual StatusCode RootHistCnv::RNTupleCnv::writeData	(	TTree *	rtree,
		INTuple *	pObj
	)

protectedpure virtual

Write N tuple data.

Implemented in RootHistCnv::RCWNTupleCnv, and RootHistCnv::RRWNTupleCnv.

Member Data Documentation

◆ m_ntupleSvc

SmartIF<INTupleSvc> RootHistCnv::RNTupleCnv::m_ntupleSvc

protected

Reference to N tuple service.

Definition at line 64 of file RNTupleCnv.h.

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

RootHistCnv/src/RNTupleCnv.h
RootHistCnv/src/RNTupleCnv.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RNTupleCnv()

Member Function Documentation

◆ book()

◆ createObj()

◆ createRep()

◆ finalize()

◆ initialize()

◆ load()

◆ readData()

◆ rootVarType()

◆ updateObj()

◆ updateRep()

◆ writeData()

Member Data Documentation

◆ m_ntupleSvc