The Gaudi Framework  v36r9p1 (5c15b2bb)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
RootHistCnv::RNTupleCnv Class Referenceabstract

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

Inheritance diagram for RootHistCnv::RNTupleCnv:
Inheritance graph
[legend]
Collaboration diagram for RootHistCnv::RNTupleCnv:
Collaboration graph
[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 ) {}

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.

97 {
98  MsgStream log( msgSvc(), "RNTupleCnv" );
99 
100  IRegistry* pReg = pAddress->registry();
101 
102  // log << MSG::WARNING << "adr: " << pAddress->par()[0] << " <> "
103  // << pAddress->par()[1] << " <> " << pAddress->ipar()[0] << " <> "
104  // << pAddress->ipar()[1] << " <> " << hex << rAddr->tObj()
105  // << dec << " <> " << pReg->identifier() << endmsg;
106 
107  std::string ident = pReg->identifier();
108 
109  StatusCode status = readObject( pAddress, refpObject ); // Doesn't do anything
110  if ( status.isSuccess() ) {
111  RootObjAddress* rAddr = dynamic_cast<RootObjAddress*>( pAddress );
112  if ( !rAddr ) {
113  log << MSG::ERROR << "Could not cast to RootObjAddress" << endmsg;
114  return StatusCode::FAILURE;
115  }
116  INTuple* nt = nullptr;
117  TTree* tobj = (TTree*)rAddr->tObj();
118  status = load( tobj, nt );
119  if ( status.isSuccess() ) {
120  refpObject = dynamic_cast<DataObject*>( nt );
121  } else {
122  log << MSG::ERROR << "Problems loading ntuple id: " << pReg->identifier() << endmsg;
123  }
124  }
125  return status;
126 }

◆ 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.

132 {
133  GlobalDirectoryRestore restore;
134  pAddr = nullptr;
135  try {
136  IRegistry* pReg = pObject->registry();
137  if ( pReg ) {
138  pAddr = pReg->address();
139  if ( !pAddr ) {
140  auto dataMgr = dataProvider().as<IDataManagerSvc>();
141  if ( dataMgr ) {
142  IRegistry* pParentReg = nullptr;
143  StatusCode status = dataMgr->objectParent( pReg, pParentReg );
144  if ( status.isSuccess() ) {
145  IOpaqueAddress* pParAddr = pParentReg->address();
146  if ( pParAddr ) {
147  TDirectory* pParentDir = (TDirectory*)pParAddr->ipar()[0];
148  if ( pParentDir ) {
149  TTree* pTree = nullptr;
150  auto dsc = pReg->name().substr( 1 );
151  gDirectory = pParentDir;
152  status = book( dsc, dynamic_cast<INTuple*>( pObject ), pTree );
153  if ( !status.isSuccess() ) { return status; }
154  status = createAddress( pObject, gDirectory, pTree, pAddr );
155  if ( !status.isSuccess() ) { return status; }
156  return writeData( pTree, dynamic_cast<INTuple*>( pObject ) );
157  }
158  }
159  }
160  }
161  } else {
162  TDirectory* pDir = (TDirectory*)pAddr->ipar()[0];
163  RootObjAddress* rAddr = dynamic_cast<RootObjAddress*>( pAddr );
164  if ( !rAddr ) {
165  MsgStream log( msgSvc(), "RNTupleCnv" );
166  log << MSG::ERROR << "Could not cast to RootObjAddress" << endmsg;
167  return StatusCode::FAILURE;
168  }
169  TTree* pTree = (TTree*)rAddr->tObj();
170  gDirectory = pDir;
171  return writeData( pTree, dynamic_cast<INTuple*>( pObject ) );
172  }
173  }
174  } catch ( ... ) {}
175  MsgStream log( msgSvc(), "RNTupleCnv" );
176  log << MSG::ERROR << "Failed to create persistent N-tuple!" << endmsg;
177  return StatusCode::FAILURE;
178 }

◆ finalize()

StatusCode RootHistCnv::RNTupleCnv::finalize ( )
override

Finalize the converter.

Definition at line 61 of file RNTupleCnv.cpp.

61  {
62  //-----------------------------------------------------------------------------
63  m_ntupleSvc.reset();
64  return Converter::finalize();
65 }

◆ initialize()

StatusCode RootHistCnv::RNTupleCnv::initialize ( )
override

Initialize the converter.

Definition at line 49 of file RNTupleCnv.cpp.

49  {
50  //-----------------------------------------------------------------------------
51  StatusCode status = Converter::initialize();
52  if ( status.isSuccess() ) {
53  m_ntupleSvc = serviceLocator()->service( "NTupleSvc" );
54  if ( !m_ntupleSvc ) status = StatusCode::FAILURE;
55  }
56  return status;
57 }

◆ 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.

210  {
211  //-----------------------------------------------------------------------------
212  switch ( type ) {
213  case DataTypeInfo::BOOL:
214  return "/O"; // bool
215  case DataTypeInfo::SHORT:
216  return "/S"; // short
217  case DataTypeInfo::INT:
218  return "/I"; // int
219  case DataTypeInfo::LONG:
220  return "/I"; // long
221  case DataTypeInfo::LONGLONG:
222  return "/L"; // long long
223  case DataTypeInfo::USHORT:
224  return "/s"; // ushort
225  case DataTypeInfo::UINT:
226  return "/i"; // uint
227  case DataTypeInfo::ULONG:
228  return "/i"; // ulong
229  case DataTypeInfo::ULONGLONG:
230  return "/l"; // unsigned long long
231  case DataTypeInfo::FLOAT:
232  return "/F"; // float
233  case DataTypeInfo::DOUBLE:
234  return "/D"; // double
235  case DataTypeInfo::CHAR:
236  return "/B"; // char
237  case DataTypeInfo::UCHAR:
238  return "/b"; // char
239  default:
240  return "";
241  }
242  // cannot reach this point
243 }

◆ 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.

71 {
72  MsgStream log( msgSvc(), "RNTupleCnv" );
73 
74  StatusCode status = StatusCode::FAILURE;
75 
76  RootObjAddress* rAddr = dynamic_cast<RootObjAddress*>( pAddress );
77 
78  if ( !rAddr ) {
79  log << MSG::ERROR << "Could not dynamic cast to RootObjAddress" << endmsg;
80  return StatusCode::FAILURE;
81  }
82 
83  TTree* rtree = (TTree*)rAddr->tObj();
84 
85  try {
86  unsigned long* info = (unsigned long*)pAddress->ipar();
87  setDirectory( pAddress->par()[0] );
88  status = readData( rtree, dynamic_cast<INTuple*>( pObject ), info[1]++ );
89  } catch ( ... ) {}
90  return status;
91 }

◆ 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.

184 {
185  MsgStream log( msgSvc(), "RNTupleCnv" );
186  if ( pAddr ) {
187  GlobalDirectoryRestore restore;
188  TDirectory* pDir = (TDirectory*)pAddr->ipar()[0];
189  RootObjAddress* rAddr = dynamic_cast<RootObjAddress*>( pAddr );
190  if ( !rAddr ) {
191  log << MSG::ERROR << "Could not cast to RootObjAddress" << endmsg;
192  return StatusCode::FAILURE;
193  }
194  TTree* pTree = (TTree*)rAddr->tObj();
195  if ( pDir && pTree ) {
196  gDirectory->cd( pDir->GetPath() );
197  pTree->Write( "", TObject::kOverwrite );
198  return StatusCode::SUCCESS;
199  }
200  } else {
201  log << MSG::WARNING << "empty ntuple: " << pObj->registry()->identifier() << endmsg;
202  return createRep( pObj, pAddr );
203  }
204  return StatusCode::FAILURE;
205 }

◆ 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:
Converter::dataProvider
SmartIF< IDataProviderSvc > & dataProvider() const override
Get Data provider service.
Definition: Converter.cpp:78
std::string
STL class.
RootHistCnv::RNTupleCnv::createRep
StatusCode createRep(DataObject *pObj, IOpaqueAddress *&refpAddr) override
Convert the transient object to the requested representation.
Definition: RNTupleCnv.cpp:130
Gaudi.Configuration.log
log
Definition: Configuration.py:28
IDataManagerSvc
Definition: IDataManagerSvc.h:55
StatusCode::isSuccess
bool isSuccess() const
Definition: StatusCode.h:314
IOpaqueAddress
Definition: IOpaqueAddress.h:33
SmartIF::reset
void reset(TYPE *ptr=nullptr)
Set the internal pointer to the passed one disposing of the old one.
Definition: SmartIF.h:96
RootHistCnv::RConverter::RConverter
RConverter(const CLID &clid, ISvcLocator *svc)
Standard constructor.
Definition: RConverter.h:65
MSG::WARNING
@ WARNING
Definition: IMessageSvc.h:25
IRegistry
Definition: IRegistry.h:32
DataTypeInfo::USHORT
@ USHORT
Definition: DataTypeInfo.h:36
RootHistCnv::RConverter::setDirectory
void setDirectory(const std::string &loc)
Definition: RConverter.cpp:118
DataTypeInfo::ULONG
@ ULONG
Definition: DataTypeInfo.h:38
DataTypeInfo::LONG
@ LONG
Definition: DataTypeInfo.h:42
DataTypeInfo::DOUBLE
@ DOUBLE
Definition: DataTypeInfo.h:45
IRegistry::name
virtual const name_type & name() const =0
Name of the directory (or key)
StatusCode
Definition: StatusCode.h:65
DataTypeInfo::SHORT
@ SHORT
Definition: DataTypeInfo.h:40
RootHistCnv::RNTupleCnv::m_ntupleSvc
SmartIF< INTupleSvc > m_ntupleSvc
Reference to N tuple service.
Definition: RNTupleCnv.h:64
RootHistCnv::RConverter::createAddress
StatusCode createAddress(DataObject *pObject, TDirectory *pDir, TObject *pTObject, IOpaqueAddress *&refpAddr)
Create address of the transient object according to the requested representation.
Definition: RConverter.cpp:165
Converter::serviceLocator
SmartIF< ISvcLocator > & serviceLocator() const
Retrieve pointer to service locator.
Definition: Converter.cpp:102
INTuple
Definition: INTuple.h:91
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:203
RootHistCnv::RNTupleCnv::writeData
virtual StatusCode writeData(TTree *rtree, INTuple *pObj)=0
Write N tuple data.
MsgStream
Definition: MsgStream.h:34
GlobalDirectoryRestore
Definition: RConverter.h:26
DataTypeInfo::FLOAT
@ FLOAT
Definition: DataTypeInfo.h:44
SmartIF::as
SmartIF< IFace > as() const
return a new SmartIF instance to another interface
Definition: SmartIF.h:117
std::string::substr
T substr(T... args)
IRegistry::address
virtual IOpaqueAddress * address() const =0
Retrieve opaque storage address.
gaudirun.type
type
Definition: gaudirun.py:160
DataTypeInfo::UCHAR
@ UCHAR
Definition: DataTypeInfo.h:35
DataTypeInfo::UINT
@ UINT
Definition: DataTypeInfo.h:37
StatusCode::SUCCESS
constexpr static const auto SUCCESS
Definition: StatusCode.h:100
DataTypeInfo::BOOL
@ BOOL
Definition: DataTypeInfo.h:43
MSG::ERROR
@ ERROR
Definition: IMessageSvc.h:25
DataTypeInfo::ULONGLONG
@ ULONGLONG
Definition: DataTypeInfo.h:55
DataObject
Definition: DataObject.h:40
IRegistry::identifier
virtual const id_type & identifier() const =0
Full identifier (or key)
RootHistCnv::RConverter::readObject
virtual StatusCode readObject(IOpaqueAddress *pAddr, DataObject *&refpObj)
Create the transient representation of an object.
Definition: RConverter.cpp:260
DataTypeInfo::LONGLONG
@ LONGLONG
Definition: DataTypeInfo.h:54
Converter::initialize
StatusCode initialize() override
Initialize the converter.
Definition: Converter.cpp:53
Converter::msgSvc
SmartIF< IMessageSvc > & msgSvc() const
Retrieve pointer to message service.
Definition: Converter.cpp:105
StatusCode::FAILURE
constexpr static const auto FAILURE
Definition: StatusCode.h:101
RootHistCnv::RNTupleCnv::readData
virtual StatusCode readData(TTree *rtree, INTuple *pObj, long ievt)=0
Read N tuple data.
DataObject::registry
IRegistry * registry() const
Get pointer to Registry.
Definition: DataObject.h:82
RootHistCnv::RNTupleCnv::load
virtual StatusCode load(TTree *tree, INTuple *&refpObj)=0
Create the transient representation of an object.
RootHistCnv::RNTupleCnv::book
virtual StatusCode book(const std::string &desc, INTuple *pObj, TTree *&tree)=0
Book a new N tuple.
DataTypeInfo::INT
@ INT
Definition: DataTypeInfo.h:41
Converter::finalize
StatusCode finalize() override
Initialize the converter.
Definition: Converter.cpp:60
DataTypeInfo::CHAR
@ CHAR
Definition: DataTypeInfo.h:39
IOpaqueAddress::ipar
virtual const unsigned long * ipar() const =0
Access to generic link parameters.