Row wise NTuple converter class definition. More...

#include </builds/gaudi/Gaudi/RootHistCnv/src/RRWNTupleCnv.h>

Inheritance diagram for RootHistCnv::RRWNTupleCnv:

Collaboration diagram for RootHistCnv::RRWNTupleCnv:

Public Member Functions
	RRWNTupleCnv (ISvcLocator *svc)
	Standard constructor.
Public Member Functions inherited from RootHistCnv::RNTupleCnv
StatusCode	initialize () override
	Initialize the converter.
StatusCode	finalize () override
	Finalize the converter.
StatusCode	createObj (IOpaqueAddress pAddr, DataObject &refpObj) override
	Create the transient representation of an object.
StatusCode	updateObj (IOpaqueAddress pAddr, DataObject refpObj) override
	Update the transient object from the other representation.
StatusCode	createRep (DataObject pObj, IOpaqueAddress &refpAddr) override
	Convert the transient object to the requested representation.
StatusCode	updateRep (IOpaqueAddress pAddr, DataObject pObj) override
	Update the converted representation of a transient object.
Public Member Functions inherited from RootHistCnv::RConverter
StatusCode	createRep (DataObject pObj, IOpaqueAddress &refpAddr) override
	Convert the transient object to the requested representation.
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 &)
Public Member Functions inherited from Converter
StatusCode	initialize () override
	Initialize the converter.
StatusCode	finalize () override
	Initialize the converter.
StatusCode	setDataProvider (IDataProviderSvc *svc) override
	Set Data provider service.
SmartIF< IDataProviderSvc > &	dataProvider () const override
	Get Data provider service.
StatusCode	setConversionSvc (IConversionSvc *svc) override
	Set conversion service the converter is connected to.
SmartIF< IConversionSvc >	conversionSvc () override
	Get conversion service the converter is connected to.
StatusCode	setAddressCreator (IAddressCreator *creator) override
	Set address creator facility.
SmartIF< IAddressCreator > &	addressCreator () const override
	Retrieve address creator facility.
const CLID &	objType () const override
	Retrieve the class type of objects the converter produces.
virtual long	i_repSvcType () const
	Retrieve the class type of the data store the converter uses.
StatusCode	createObj (IOpaqueAddress pAddress, DataObject &refpObject) override
	Create the transient representation of an object.
StatusCode	fillObjRefs (IOpaqueAddress pAddress, DataObject pObject) override
	Resolve the references of the created transient object.
StatusCode	updateObj (IOpaqueAddress pAddress, DataObject refpObject) override
	Update the transient object from the other representation.
StatusCode	updateObjRefs (IOpaqueAddress pAddress, DataObject pObject) override
	Update the references of an updated transient object.
StatusCode	createRep (DataObject pObject, IOpaqueAddress &refpAddress) override
	Convert the transient object to the requested representation.
StatusCode	fillRepRefs (IOpaqueAddress pAddress, DataObject pObject) override
	Resolve the references of the converted object.
StatusCode	updateRep (IOpaqueAddress pAddress, DataObject pObject) override
	Update the converted representation of a transient object.
StatusCode	updateRepRefs (IOpaqueAddress pAddress, DataObject pObject) override
	Update the references of an already converted object.
	Converter (long storage_type, const CLID &class_type, ISvcLocator *svc=0)
	Standard Constructor.
SmartIF< IService >	service (const std::string &name, const bool createIf=true) const
	Return a pointer to the service identified by name (or "type/name").
Public Member Functions inherited from implements< IConverter >
void const *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast.
StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface.
std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames.
	implements ()=default
	Default constructor.
implements &	operator= (const implements &)
	Assignment operator (do not touch the reference count).
unsigned long	addRef () const override
	Reference Interface instance.
unsigned long	release () const override
	Release Interface instance.
unsigned long	refCount () const override
	Current reference count.

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

Protected Member Functions
StatusCode	load (TTree tree, INTuple &refpObject) override
	Create the transient representation of an object.
StatusCode	book (const std::string &desc, INTuple pObject, TTree &tree) override
	Book the N tuple.
StatusCode	writeData (TTree rtree, INTuple pObject) override
	Write N tuple data.
StatusCode	readData (TTree rtree, INTuple pObject, long ievt) override
	Read N tuple data.
Protected Member Functions inherited from RootHistCnv::RNTupleCnv
	RNTupleCnv (ISvcLocator *svc, const CLID &clid)
	Standard constructor.
virtual std::string	rootVarType (int)
	Return ROOT type info:
Protected Member Functions inherited from RootHistCnv::RConverter
	RConverter (const CLID &clid, ISvcLocator *svc)
	Standard constructor.
virtual StatusCode	readObject (IOpaqueAddress pAddr, DataObject &refpObj)
	Create the transient representation of an object.
virtual TObject *	createPersistent (DataObject *pObj)
	Create the persistent representation of an object.
StatusCode	createAddress (DataObject pObject, TDirectory pDir, TObject pTObject, IOpaqueAddress &refpAddr)
	Create address of the transient object according to the requested representation.
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).
Protected Member Functions inherited from Converter
SmartIF< ISvcLocator > &	serviceLocator () const
	Retrieve pointer to service locator.
SmartIF< IMessageSvc > &	msgSvc () const
	Retrieve pointer to message service.
SmartIF< IDataManagerSvc > &	dataManager () const
	Get Data Manager service.
Protected Member Functions inherited from implements< IConverter >
unsigned long	decRef () const override

Additional Inherited Members
Public Types inherited from Converter
using	Factory = Gaudi::PluginService::Factory<IConverter( ISvcLocator )>
Public Types inherited from implements< IConverter >
using	base_class
	Typedef to this class.
using	extend_interfaces_base
	Typedef to the base of this class.
using	iids
Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids
	take union of the ext_iids of all Interfaces...
Protected Attributes inherited from RootHistCnv::RNTupleCnv
SmartIF< INTupleSvc >	m_ntupleSvc
	Reference to N tuple service.
Protected Attributes inherited from implements< IConverter >
std::atomic_ulong	m_refCount
	Reference counter.

Detailed Description

Row wise NTuple converter class definition.

Author: Charles Leggett

Definition at line 26 of file RRWNTupleCnv.h.

Constructor & Destructor Documentation

◆ RRWNTupleCnv()

RootHistCnv::RRWNTupleCnv::RRWNTupleCnv ( ISvcLocator * svc )

inline

Standard constructor.

Definition at line 31 of file RRWNTupleCnv.h.

31: RNTupleCnv( svc, classID() ) {}

RootHistCnv::RNTupleCnv::RNTupleCnv

RNTupleCnv(ISvcLocator *svc, const CLID &clid)

Standard constructor.

Definition RNTupleCnv.cpp:38

RootHistCnv::RRWNTupleCnv::classID

static const CLID & classID()

Inquire class type.

Definition RRWNTupleCnv.h:29

Member Function Documentation

◆ book()

StatusCode RootHistCnv::RRWNTupleCnv::book	(	const std::string &	desc,
		INTuple *	pObject,
		TTree *&	tree )

overrideprotectedvirtual

Book the N tuple.

Implements RootHistCnv::RNTupleCnv.

Definition at line 26 of file RRWNTupleCnv.cpp.

{
  MsgStream log( msgSvc(), "RRWNTupleCnv" );
  // Book the tree
  rtree = new TTree( desc.c_str(), nt->title().c_str() );
  // Add the branches
  for ( const auto& i : nt->items() ) {
    std::string tag = i->name() + rootVarType( i->type() );
    // add the branch
    log << MSG::INFO << "ID " << desc << ": added branch: " << i->name() << " / " << tag << endmsg;
    rtree->Branch( i->name().c_str(), const_cast<void*>( i->buffer() ), tag.c_str() );
  }
  log << MSG::INFO << "Booked TTree with ID:" << desc << " \"" << nt->title() << "\"" << endmsg;
  return StatusCode::SUCCESS;
}

◆ classID()

const CLID & RootHistCnv::RRWNTupleCnv::classID ( )

inlinestatic

Inquire class type.

Definition at line 29 of file RRWNTupleCnv.h.

29{ return CLID_RowWiseTuple; }

◆ load()

StatusCode RootHistCnv::RRWNTupleCnv::load	(	TTree *	tree,
		INTuple *&	refpObject )

overrideprotectedvirtual

Create the transient representation of an object.

Implements RootHistCnv::RNTupleCnv.

Definition at line 69 of file RRWNTupleCnv.cpp.

{
  return StatusCode::FAILURE;
}

◆ readData()

StatusCode RootHistCnv::RRWNTupleCnv::readData	(	TTree *	rtree,
		INTuple *	pObject,
		long	ievt )

overrideprotectedvirtual

Read N tuple data.

Implements RootHistCnv::RNTupleCnv.

Definition at line 62 of file RRWNTupleCnv.cpp.

{
  return StatusCode::FAILURE;
}

◆ writeData()

StatusCode RootHistCnv::RRWNTupleCnv::writeData	(	TTree *	rtree,
		INTuple *	pObject )

overrideprotectedvirtual

Write N tuple data.

Implements RootHistCnv::RNTupleCnv.

Definition at line 44 of file RRWNTupleCnv.cpp.

{
  if ( rtree ) {
    // Fill the tree;
    rtree->Fill();
    // Reset the NTuple
    nt->reset();
    return StatusCode::SUCCESS;
  }
  MsgStream log( msgSvc(), "RRWNTupleCnv" );
  log << MSG::ERROR << "Attempt to write invalid N-tuple.";
  if ( nt ) log << nt->title();
  log << endmsg;
  return StatusCode::FAILURE;
}

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

RootHistCnv/src/RRWNTupleCnv.h
RootHistCnv/src/RRWNTupleCnv.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RRWNTupleCnv()

Member Function Documentation

◆ book()

◆ classID()

◆ load()

◆ readData()

◆ writeData()